diff options
Diffstat (limited to 'ansible_collections/ieisystem/inmanage')
272 files changed, 65075 insertions, 0 deletions
diff --git a/ansible_collections/ieisystem/inmanage/.github/settings.yml b/ansible_collections/ieisystem/inmanage/.github/settings.yml new file mode 100644 index 000000000..b27b575f0 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/.github/settings.yml @@ -0,0 +1,5 @@ +# DO NOT MODIFY + +# Settings: https://probot.github.io/apps/settings/ +# Pull settings from https://github.com/ansible-collections/.github/blob/master/.github/settings.yml +_extends: ".github" diff --git a/ansible_collections/ieisystem/inmanage/.github/workflows/ansible-test.yml b/ansible_collections/ieisystem/inmanage/.github/workflows/ansible-test.yml new file mode 100644 index 000000000..52759559b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/.github/workflows/ansible-test.yml @@ -0,0 +1,54 @@ +name: CI +on: + pull_request: + push: + # Run CI once per day (at 06:00 UTC) + # This ensures that even if there haven't been commits that we are still testing against latest version of ansible-test for each ansible-base version + schedule: + - cron: '0 6 * * *' + +jobs: + sanity: + name: Sanity (${{ matrix.ansible }}) + strategy: + matrix: + ansible: + - stable-2.14 + - stable-2.15 + - stable-2.16 + - stable-2.17 + - devel + python-version: + - '3.9' + - '3.10' + - '3.11' + - '3.12' + exclude: + - ansible: stable-2.14 + python-version: '3.12' + - ansible: stable-2.15 + python-version: '3.12' + - ansible: stable-2.16 + python-version: '3.9' + - ansible: stable-2.17 + python-version: '3.9' + - ansible: devel + python-version: '3.9' + runs-on: ubuntu-latest + steps: + + - name: Check out code + uses: actions/checkout@v1 + with: + path: ansible_collections/ieisystem/inmanage + + - name: Set up Python (${{ matrix.python-version }}) + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + + - name: Install ansible-base (${{ matrix.ansible }}) + run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check + + - name: Run sanity tests + run: ansible-test sanity --docker -v --color diff --git a/ansible_collections/ieisystem/inmanage/CHANGELOG.rst b/ansible_collections/ieisystem/inmanage/CHANGELOG.rst new file mode 100644 index 000000000..784876c36 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/CHANGELOG.rst @@ -0,0 +1,200 @@ +==================================================== +CHANGE THIS IN changelogs/config.yaml! Release Notes +==================================================== + +.. contents:: Topics + + +v1.2.1 +====== + +Bugfixes +-------- + +- Change the example gather_facts no to false(https://github.com/ieisystem/ieisystem.inmanage/pull/18). +- Delete the unwanted links.yml file (https://github.com/ieisystem/ieisystem.inmanage/pull/19). + +v1.2.0 +====== + +Removed Features (previously deprecated) +---------------------------------------- + +- add_ldisk - Delete the ``add_ldisk.info`` parameter. Use ``ieisystem.inmanage.pdisk_info`` instead (https://github.com/ieisystem/ieisystem.inmanage/pull/15). +- edit_ldisk - Delete the ``edit_ldisk.info`` parameter. Use ``ieisystem.inmanage.ldisk_info`` instead (https://github.com/ieisystem/ieisystem.inmanage/pull/15). +- edit_pdisk - Delete the ``edit_pdisk.info`` parameter. Use ``ieisystem.inmanage.pdisk_info`` instead (https://github.com/ieisystem/ieisystem.inmanage/pull/15). + +Bugfixes +-------- + +- Add ansible 2.17 version tests to our CI test scripts. +- Delete the useless __init__.py file in modules and module_utils. +- Modify the add_ldisk, edit_ldisk, and edit_pdisk module.rst documents (https://github.com/ieisystem/ieisystem.inmanage/pull/16). + +v1.1.1 +====== + +Minor Changes +------------- + +- Change edit_alert_policy module description information does not have the first letter capitalization problem. +- Fix problems such as typos or grammatical errors in the document. +- Modify the readme.md information about installing supported modules. + +v1.1.0 +====== + +Minor Changes +------------- + +- Fix any issues in your module that don't meet the ansible module format and documentation requirements. +- Modify the CI test file to add Ansile-2.16 and python 3.12 tests. +- Modify the collection description in the README.md file. + +v1.0.0 +====== + +Major Changes +------------- + +- add all modules. + +Minor Changes +------------- + +- Change the referenced sdk name to inManage. +- Change the value of tags in galaxy.xml. +- Example Change the version to 1.0.0. +- Modify the release plan link in the readme file. + +New Modules +----------- + +- ad_group - Manage active directory group information +- ad_group_info - Get active directory group information +- ad_info - Get active directory information +- adapter_info - Get adapter information +- add_ldisk - Create logical disk +- alert_policy_info - Get alert policy +- audit_log_info - Get BMC audit log information +- auto_capture_info - Get auto capture screen information +- backplane_info - Get disk backplane information +- backup - Backup server settings +- bios_export - Export BIOS config +- bios_import - Import BIOS config +- bios_info - Get BIOS setup +- bmc_info - Get BMC information +- boot_image_info - Get bmc boot image information +- boot_option_info - Get BIOS boot options +- clear_audit_log - Clear BMC audit log +- clear_event_log - Clear event log +- clear_system_log - Clear BMC system log +- collect_blackbox - Collect blackbox log +- collect_log - Collect logs +- connect_media_info - Get remote images redirection information +- cpu_info - Get CPU information +- del_session - Delete session +- dns_info - Get dns information +- download_auto_screenshot - Download auto screenshots +- download_manual_screenshot - Download manual screenshots +- edit_ad - Set active directory information +- edit_alert_policy - Set alert policy +- edit_auto_capture - Set auto capture screen +- edit_bios - Set BIOS setup attributes +- edit_boot_image - Set bmc boot image +- edit_boot_option - Set BIOS boot options +- edit_connect_media - Start/Stop virtual media Image +- edit_dns - Set dns information +- edit_event_log_policy - Set event log policy +- edit_fan - Set fan information +- edit_fru - Set fru settings +- edit_ipv4 - Set ipv4 information +- edit_ipv6 - Set ipv6 information +- edit_kvm - Set KVM +- edit_ldap - Set ldap information +- edit_ldisk - Set logical disk +- edit_log_setting - Set bmc system and audit log setting +- edit_m6_log_setting - Set bmc system and audit log setting +- edit_manual_capture - Set manual capture screen +- edit_media_instance - Set Virtual Media Instance +- edit_ncsi - Set ncsi information +- edit_network - Set network information +- edit_network_bond - Set network bond +- edit_network_link - Set network link +- edit_ntp - Set NTP +- edit_pdisk - Set physical disk +- edit_power_budget - Set power budget information +- edit_power_restore - Set power restore information +- edit_power_status - Set power status information +- edit_preserve_config - Set preserve config +- edit_psu_config - Set psu config information +- edit_psu_peak - Set psu peak information +- edit_restore_factory_default - Set preserver config +- edit_service - Set service settings +- edit_smtp - Set SMTP information +- edit_smtp_com - Set SMTP information +- edit_smtp_dest - Set SMTP information +- edit_snmp - Set snmp +- edit_snmp_trap - Set snmp trap +- edit_threshold - Set threshold information +- edit_uid - Set UID +- edit_virtual_media - Set virtual media +- edit_vlan - Set vlan information +- event_log_info - Get event log information +- event_log_policy_info - Get event log policy information +- fan_info - Get fan information +- fru_info - Get fru information +- fw_version_info - Get firmware version information +- gpu_info - Get GPU information +- hard_disk_info - Get hard disk information +- hba_info - Get CPU information +- kvm_info - Get KVM information +- ldap_group - Manage ldap group information +- ldap_group_info - Get ldap group information +- ldap_info - Get ldap information +- ldisk_info - Get logical disks information +- log_setting_info - Get bmc log setting information +- media_instance_info - Get Virtual Media Instance information +- mem_info - Get memory information +- ncsi_info - Get ncsi information +- network_bond_info - Get network bond information +- network_info - Get network information +- network_link_info - Get network link information +- ntp_info - Get NTP information +- onboard_disk_info - Get onboard disks information +- pcie_info - Get PCIE information +- pdisk_info - Get physical disks information +- power_budget_info - Get power budget information +- power_consumption_info - Get power consumption information +- power_restore_info - Get power restore information +- power_status_info - Get power status information +- preserve_config_info - Get preserve config information +- psu_config_info - Get psu config information +- psu_info - Get psu information +- psu_peak_info - Get psu peak information +- raid_info - Get RAID/HBA card and controller information +- reset_bmc - BMC reset +- reset_kvm - KVM reset +- restore - Restore server settings +- self_test_info - Get self test information +- sensor_info - Get sensor information +- server_info - Get server status information +- service_info - Get service information +- session_info - Get online session information +- smtp_info - Get SMTP information +- snmp_info - Get snmp get/set information +- snmp_trap_info - Get snmp trap information +- support_info - Get support information +- system_log_info - Get BMC system log information +- temp_info - Get temp information +- threshold_info - Get threshold information +- uid_info - Get UID information +- update_cpld - Update CPLD +- update_fw - Update firmware +- update_psu - Update PSU +- user - Manage user +- user_group - Manage user group +- user_group_info - Get user group information +- user_info - Get user information +- virtual_media_info - Get Virtual Media information +- volt_info - Get volt information diff --git a/ansible_collections/ieisystem/inmanage/CODE_OF_CONDUCT.md b/ansible_collections/ieisystem/inmanage/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..0164155b8 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Community Code of Conduct + +Please see the official [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html). diff --git a/ansible_collections/ieisystem/inmanage/FILES.json b/ansible_collections/ieisystem/inmanage/FILES.json new file mode 100644 index 000000000..cae971560 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/FILES.json @@ -0,0 +1,1972 @@ +{ + "files": [ + { + "name": ".", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "plugins", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "plugins/module_utils", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "plugins/module_utils/inmanage.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "674d33cbdf8ddfd68b4884adefa1d4ec6e4e8f8565c82516db536148f1e63080", + "format": 1 + }, + { + "name": "plugins/modules", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "plugins/modules/volt_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "35e11277637a095fddc146c0cd09e2328e1d23adeacd4c82e11ce25bcb2a6a97", + "format": 1 + }, + { + "name": "plugins/modules/virtual_media_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ea6f4a789bb7c0aac75fe40423bdc21aff07566934cc4aca5d557d850069253f", + "format": 1 + }, + { + "name": "plugins/modules/user_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c83c1dbd00c068c5693d84e64a56cb1267d6e4c8c015751a2cdf579d5cac2c9d", + "format": 1 + }, + { + "name": "plugins/modules/user_group_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "467200e70a20631b08a1c6849b937ccd455a85f425705def7db6e5cef5c537ca", + "format": 1 + }, + { + "name": "plugins/modules/user_group.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8455a0e4f76ca807a25283a35d13108a6817554a51b9ffa7e909ea4578e6406e", + "format": 1 + }, + { + "name": "plugins/modules/user.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a1bf384485164ac2ea5a12362a8cf009ec6c08796d107af9fe19b9ad46a0917e", + "format": 1 + }, + { + "name": "plugins/modules/update_psu.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "27a01340519e2cab4aa42bb6ad64b7c48d423294b94e82285cd423a9bb034f7c", + "format": 1 + }, + { + "name": "plugins/modules/update_fw.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2d7725050206c34d1bc96c06d9424c65f5a06bb5db50daad9605445ad4508c06", + "format": 1 + }, + { + "name": "plugins/modules/update_cpld.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3375918f14014feb55a40eaedbdb3ab843a68eb37b2a2426605e879e87811175", + "format": 1 + }, + { + "name": "plugins/modules/uid_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "34b6b217d5f0b8f88b4ada18532a46ce8375b25e05e0de16ce761b781a5b3869", + "format": 1 + }, + { + "name": "plugins/modules/threshold_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "edc36a4d148ac2a54cbbb7954407b5e92cb32262bbe48222f4be520a19b7660d", + "format": 1 + }, + { + "name": "plugins/modules/temp_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e479345ca0dd5b7bb6a622c176d7ac944fd2198fb9f9faa46b440e992ad85af1", + "format": 1 + }, + { + "name": "plugins/modules/system_log_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b3ea90af4d763f9fc2e6b247bfc53e28569eb0c21b881d46a644d10812b01d9b", + "format": 1 + }, + { + "name": "plugins/modules/support_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e5f426d4843b13007778981662892b07b513166b67af978115eeba1e0dbdd084", + "format": 1 + }, + { + "name": "plugins/modules/snmp_trap_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "39c509d2045924b661be86c8dc2063a07bfd69dd6e7ed1c9e26dcaf278a397a8", + "format": 1 + }, + { + "name": "plugins/modules/snmp_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8e5391275302a9db5e816516173ca06d44df57866a833f7387f2e0a7af639169", + "format": 1 + }, + { + "name": "plugins/modules/smtp_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a5cd04d75040bbfc5f228bdde374754a6065ec23a0be6ab4acabcfb4e0df8cdb", + "format": 1 + }, + { + "name": "plugins/modules/session_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2fff989fe31bd8748c753defa873c0b689bedd71aa0269bf307729e3f6b34032", + "format": 1 + }, + { + "name": "plugins/modules/service_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9d6da3c3b34cf7df4441c4c897cbf582f58b3a85e68d97624b121d581d3260b3", + "format": 1 + }, + { + "name": "plugins/modules/server_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "be394d0394a5522e84d49c8ca91154e02df6fecb52be08e085f7880505bb5852", + "format": 1 + }, + { + "name": "plugins/modules/sensor_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8c7b38763bdc27709f19d4f5eb6b2f8bf4f0620675e599ae889366cc91f2e534", + "format": 1 + }, + { + "name": "plugins/modules/self_test_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6fc2aad1286b56f1242809b8ba9d3a8a558ef49ad0885545daab8713eac47490", + "format": 1 + }, + { + "name": "plugins/modules/restore.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2c587ddb2cbaf9318340840265439f155d8cbd3fe9a3e6f3ca2aba80206908e5", + "format": 1 + }, + { + "name": "plugins/modules/reset_kvm.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4150e999b3606aca59d4925811b363be38d3d78e58def3ef14db2b3a17517adb", + "format": 1 + }, + { + "name": "plugins/modules/reset_bmc.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9f901152036ae56ec18f74efc145a2b3961631ca30c10ed0334d5222b03b5280", + "format": 1 + }, + { + "name": "plugins/modules/raid_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5736d8a65443b13041417951214b9f5e7e1945dd428d48b7c4eb15a37535938a", + "format": 1 + }, + { + "name": "plugins/modules/psu_peak_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "86a388c6a9489d4fe2e7b1e0994d12097caa82648ee839507fc8157fb67aecf2", + "format": 1 + }, + { + "name": "plugins/modules/psu_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e88f3c5bfb01e551de7c6dc582d2c493a44a17c6d18e680229ee3c031174d540", + "format": 1 + }, + { + "name": "plugins/modules/psu_config_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5301dbc916dec77d67c7fbc0437b20a1d76e8b18e8e6ea6906dd2977dfd39e3f", + "format": 1 + }, + { + "name": "plugins/modules/preserve_config_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "470b56e39bff7ae0093963e83795c55aee7390414e4fce70207035ad61a396ba", + "format": 1 + }, + { + "name": "plugins/modules/power_status_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "42ea84d4402dc768cbb2a015ba5ab47325e8596154047de524c962cf595a1f5d", + "format": 1 + }, + { + "name": "plugins/modules/power_restore_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cd82b86d6e69710f1a139a1c747749d4d8d1cd27921e023c86d44596384c19b3", + "format": 1 + }, + { + "name": "plugins/modules/power_consumption_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "29b9b7114adebf19f0ed3f952b607a9eae1dd9d039b8b98510c81153938b8dd7", + "format": 1 + }, + { + "name": "plugins/modules/power_budget_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cdcd0edd62261d7476b71f8242d48672da7c5bcdaea14f0786ccf800d93a18dc", + "format": 1 + }, + { + "name": "plugins/modules/pdisk_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "934ff4333ac7e6785a65348cde7a57bad2b0f4b0263cf199c15919b6e0c68cde", + "format": 1 + }, + { + "name": "plugins/modules/pcie_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "34cf2c3417cd4c8136713d2507d8de0422f8c8b49867baea947e7a78eb5dc36d", + "format": 1 + }, + { + "name": "plugins/modules/onboard_disk_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ae9d2174c1fbf2b68e6473e6be7a72309418a110e6ba7a47566596d405449eb2", + "format": 1 + }, + { + "name": "plugins/modules/ntp_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d7db8c45d27248471e38278e458df9ce0bec12b8436a9c2f2768aa7ce634bac1", + "format": 1 + }, + { + "name": "plugins/modules/network_link_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "28913f0873c96943cc0899e890275e4c1db0fd16b2c54ddb6d1f3437a5b3e2a2", + "format": 1 + }, + { + "name": "plugins/modules/network_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "72d70839dbd18c48283e26c35ed9082d7096f7afb33a19618d8506667b9f8b28", + "format": 1 + }, + { + "name": "plugins/modules/network_bond_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "39db41e6b0db5dc17650784c43de783d9e93e0bce7cf02f64838e6a7acc751b1", + "format": 1 + }, + { + "name": "plugins/modules/ncsi_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8dd66cc2dcae0a32d801d9ec9ce8c29dcd5e0bd0fab471204f16260c6b9a8ff1", + "format": 1 + }, + { + "name": "plugins/modules/mem_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e6ef4d7c3abd7c18d7d854dfa1d9d3b5ecbdb014d5ce23d336090570dc0980ec", + "format": 1 + }, + { + "name": "plugins/modules/media_instance_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "185f571ea14cac6182b973aea4cd2cf617b2b3dbf62058305cd533f6a3455712", + "format": 1 + }, + { + "name": "plugins/modules/log_setting_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "79b63d4b934304595b4676b9feec9b10d637e6fb131b67404cbb5e667096b695", + "format": 1 + }, + { + "name": "plugins/modules/ldisk_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "53d93e9998aa7613a21d52023e94511cdfef45275d576b4221757431532a5bf7", + "format": 1 + }, + { + "name": "plugins/modules/ldap_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ae485f5dd2bc147c4925b54a8152370bcbbe551d60a59955c7a62517e7b69254", + "format": 1 + }, + { + "name": "plugins/modules/ldap_group_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "29b3145d96d156110105e11b19b6a738ae098285ba10f1897cb183ec1336f98f", + "format": 1 + }, + { + "name": "plugins/modules/ldap_group.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0424370cf3e5d9e99c9845bc74b5eaaa9c6acb1664601709171e7bdcd95d0ea5", + "format": 1 + }, + { + "name": "plugins/modules/kvm_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9c4785c813855398f6966a6be3d8012cdc01e8cc5c08990c55b0682e48a2e3fe", + "format": 1 + }, + { + "name": "plugins/modules/hba_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5ca67398d3c5dd70d8890b069238e48bbcccfbc352bf16b9232531b2cf0c4626", + "format": 1 + }, + { + "name": "plugins/modules/hard_disk_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a771b0327a81aa14820de5f4a48b5f1933d136aa0a6e8299bffc3b7db73d340c", + "format": 1 + }, + { + "name": "plugins/modules/gpu_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "965d48b08bbb1494c6e19312ac056700563f2ed86cd0bd0ebabb54044b8fae34", + "format": 1 + }, + { + "name": "plugins/modules/fw_version_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "1b9589b792459cdc6e26ea847b40fe630756f8bc1d9d0e4714f0d750170217a8", + "format": 1 + }, + { + "name": "plugins/modules/fru_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3ff8d8a4ba4605595f16a44e78bae9650d5b9d705ab7d37ceb55b45127bba153", + "format": 1 + }, + { + "name": "plugins/modules/fan_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d07520d2c3103db0d3eb607a8252612434b88b6036fe53d4bdd7f7867343d917", + "format": 1 + }, + { + "name": "plugins/modules/event_log_policy_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5e8d89ef273f21f52243b6fdc93ca1998f824a64c0efc55ee38f7eb95ee0e771", + "format": 1 + }, + { + "name": "plugins/modules/event_log_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7f238935cad92c35ad87ac6ae595df91942b01820863f5e5d17855abe3f65791", + "format": 1 + }, + { + "name": "plugins/modules/edit_vlan.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4c3aa9680f471e7b3e105484afbe6cacc13ffacd1ca542fbdef2193ce91be796", + "format": 1 + }, + { + "name": "plugins/modules/edit_virtual_media.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "91537c68142cfa7ed851b554fb13b5c22ec69f3066c0c77ec6fd7e189815995d", + "format": 1 + }, + { + "name": "plugins/modules/edit_uid.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d2bc2dd761810a1b1752a801c12802fc2835fd76f3b80bf08bf61c0f3bf8f16a", + "format": 1 + }, + { + "name": "plugins/modules/edit_threshold.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6708029f9e5fdf8089e7918f147fb4514f4240db816454a6dde91c2fc56de003", + "format": 1 + }, + { + "name": "plugins/modules/edit_snmp_trap.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4851a078dd08ab946188235a2270423f1a5226ccdb965086316120fde6897f8d", + "format": 1 + }, + { + "name": "plugins/modules/edit_snmp.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "59b86e9af5afa660a736bc17dade5b753d10904cdb8b0e0143f9caae89eee185", + "format": 1 + }, + { + "name": "plugins/modules/edit_smtp_dest.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "fd828e0f6b89edf18d2d25f3e8177ab6d069bdb5269d962b9bfb99e31c72388e", + "format": 1 + }, + { + "name": "plugins/modules/edit_smtp_com.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "03b490198e76af34f8bc48e87b0db4d1cb003931a64b931a18d64849cea7b781", + "format": 1 + }, + { + "name": "plugins/modules/edit_smtp.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4a03d161f46728d605411eb14f98ec141955ae6ec6ac019f6d484d0e7294a415", + "format": 1 + }, + { + "name": "plugins/modules/edit_service.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "43207d255826b12f5da2f2318a3cecb3a4995da2f986b05dcc5fd663c2d7f8bb", + "format": 1 + }, + { + "name": "plugins/modules/edit_restore_factory_default.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "29a475a280a052ca00112358bbb60b083ac4fdca8ba6609f618ef655036cb8ed", + "format": 1 + }, + { + "name": "plugins/modules/edit_psu_peak.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0d2bbb08ec0c3bd3d4b25a39071b3cfaea40f07f5dc40adfd8c0613b7f8b58e9", + "format": 1 + }, + { + "name": "plugins/modules/edit_psu_config.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7f3ec8d7aa771e3672da66e4256a23d3a538d1afc60c39cea52984ddcf897cc5", + "format": 1 + }, + { + "name": "plugins/modules/edit_preserve_config.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9a8a6c699b9210bbbf1142595625a4dd765d78d7e70d3d40b272ac6e033a506f", + "format": 1 + }, + { + "name": "plugins/modules/edit_power_status.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5ded259ca31ef59efd9a940f4331ab1b5d2c29c4c174c013ec7702c846c65476", + "format": 1 + }, + { + "name": "plugins/modules/edit_power_restore.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "fc084f5bb1f72be5aed54eb4a75ae9b795536da520bea54b49202d3f84f3b052", + "format": 1 + }, + { + "name": "plugins/modules/edit_power_budget.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8db0c5d90c95396307cd4c1d54cf048a90bf76b39be4e60fec37d6b4fecbe20a", + "format": 1 + }, + { + "name": "plugins/modules/edit_pdisk.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cf103a1515f29f27d538c709e56996d896928d5cacf72e3a489e12b2de6464e4", + "format": 1 + }, + { + "name": "plugins/modules/edit_ntp.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d55a781d84a5674ececaf09aea306782d75b900adb92762c94ec2840ef47e56d", + "format": 1 + }, + { + "name": "plugins/modules/edit_network_link.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "f0d8c5fe45e1791cbe4583f2c795d3ec5b98e7f9823c0925b3b655852b063071", + "format": 1 + }, + { + "name": "plugins/modules/edit_network_bond.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ec1de92e0932d6947408c386fcfcf0a2abbd18cb30f57506265cd56eecbbaf2d", + "format": 1 + }, + { + "name": "plugins/modules/edit_network.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "721d698be67981aacb265416a20a3a2f42b020cd011dbba5bcee8908778f61e0", + "format": 1 + }, + { + "name": "plugins/modules/edit_ncsi.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "92817952bb8c03f2622c79038958dc0880ecf7f907fe41b01219f9582b7822d8", + "format": 1 + }, + { + "name": "plugins/modules/edit_media_instance.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "97b9bb2dc58f41d94a5372e49f34db83cabc1a48223d43e344896aac7551c51a", + "format": 1 + }, + { + "name": "plugins/modules/edit_manual_capture.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a5ca9fdd06f10448b88856c711b0de781227294490269d554b58fce576ae2388", + "format": 1 + }, + { + "name": "plugins/modules/edit_m6_log_setting.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2d29db568ec9be01b27bb15acff72a8cfed7dc8abf76707a5ac491ae016b4bd3", + "format": 1 + }, + { + "name": "plugins/modules/edit_log_setting.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9185d2d71a8ee13ec9dd48022d14b85ca6a29ab5a3f88f6c99fdfd21b4e613cc", + "format": 1 + }, + { + "name": "plugins/modules/edit_ldisk.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "43a349945404413b504e4c52034b9584ee602d2297e14fa2e39f3da71931f078", + "format": 1 + }, + { + "name": "plugins/modules/edit_ldap.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9a9f06ffa860f1528aae3cca4b876ef17b83beff05b123c513d900df87bc3d44", + "format": 1 + }, + { + "name": "plugins/modules/edit_kvm.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "268ae719de0140f0f14346bcaaff3bfadd3330635a448378b167d3e177e77bb2", + "format": 1 + }, + { + "name": "plugins/modules/edit_ipv6.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "97505ff3a5f5ce8899e9c289b986f612e4dfcd91dffae86f0542936c1f04e86d", + "format": 1 + }, + { + "name": "plugins/modules/edit_ipv4.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c956b56e968fa5a1b946d66ed63830be54fc055de652314ad2ee62ebbe41188d", + "format": 1 + }, + { + "name": "plugins/modules/edit_fru.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "1fc6a12d8aa5660be28457da2845328de1dd2b0722ae2432ddcb31d084ff990e", + "format": 1 + }, + { + "name": "plugins/modules/edit_fan.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6c34b0aaecf3ead5539583f0cdcda8cf02e1701995c6b79d150724cacbf1a52d", + "format": 1 + }, + { + "name": "plugins/modules/edit_event_log_policy.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "acd52414ed42dfc6a47c3f6114af9d278e22e7f85105620f45dcef8d71da2f2f", + "format": 1 + }, + { + "name": "plugins/modules/edit_dns.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "721940f75023edefccfd4cb3f05ace0868753b8b9901315fa195bd4651e818e9", + "format": 1 + }, + { + "name": "plugins/modules/edit_connect_media.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "879c4009f1fa579f86a75e8c6ed18950cb80517b245bab2cd6100dc10fe943a1", + "format": 1 + }, + { + "name": "plugins/modules/edit_boot_option.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d71e61e54ac5df198777ffd16716b45a9a3eced6a4a1f1b907cc240dfc55448c", + "format": 1 + }, + { + "name": "plugins/modules/edit_boot_image.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b02510cfe7e4820d80fa70827bd36655d21819533e836e2fedf3c74c6865e6e6", + "format": 1 + }, + { + "name": "plugins/modules/edit_bios.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "16db3e8118f5e1544b451821fa44efc9c70069935c1c44e7ad5ea04b22844af7", + "format": 1 + }, + { + "name": "plugins/modules/edit_auto_capture.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2504ad423942ce38f96201cb6b7aa58e21266d6ff5eaa9c64fadafa8194af9ba", + "format": 1 + }, + { + "name": "plugins/modules/edit_alert_policy.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cdc1b63413437cbdc11bc2382e8f092df81f8667ed20f59e20acf7a429c05f44", + "format": 1 + }, + { + "name": "plugins/modules/edit_ad.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "bd7850f714cac63c5aead4232f71c0e6b9fb241f8a3f15a2b83735ad8b969bc5", + "format": 1 + }, + { + "name": "plugins/modules/download_manual_screenshot.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0e7532104efadb0e80d39ccbd459d37f8755ab5a3a63636f3867163c36caddaa", + "format": 1 + }, + { + "name": "plugins/modules/download_auto_screenshot.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "97c125e3f8904553eeacf4536024d9e2ed7abc36d77f6fbb10a187a67f3378f3", + "format": 1 + }, + { + "name": "plugins/modules/dns_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "af1f6772351c97741e4292213aa7fdacde11802bb3c81961189a35a5af1561d2", + "format": 1 + }, + { + "name": "plugins/modules/del_session.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e39a9c7b390e97425d8c557024c726130b93dd8eae77e53401a9b2f4cea57d86", + "format": 1 + }, + { + "name": "plugins/modules/cpu_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d452193f879ab53d60fd9fcf6d1a64ed1ed77abf3c6e68c7d08f7367f2f4474a", + "format": 1 + }, + { + "name": "plugins/modules/connect_media_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7483b222b066faaf08df830f7eb7ce6648a4555eb44bb2a0cdccebee2d372ce9", + "format": 1 + }, + { + "name": "plugins/modules/collect_log.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "693abb738a5b7e87bdd140b72571b68cb290a6e23d981a23676111dec18d05cf", + "format": 1 + }, + { + "name": "plugins/modules/collect_blackbox.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c9a08a714d2ccff7f8e4af6dc4a93c45e88ddc535f9741143459d062f3865c07", + "format": 1 + }, + { + "name": "plugins/modules/clear_system_log.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6670289703da645716056999a8b21ffc0b657dcb6127b0be8fbeaf779e63c4b5", + "format": 1 + }, + { + "name": "plugins/modules/clear_event_log.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c1a94335d7a31bf2fbdc0eb51aa175434f4dd674e85f7806a034d268e90f625f", + "format": 1 + }, + { + "name": "plugins/modules/clear_audit_log.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8b4d46966c05b1648bcc9f58c163648f3567dbc1104cfb88e87b1579d0fe4d03", + "format": 1 + }, + { + "name": "plugins/modules/boot_option_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d29db881729c6a8c4ef5b8c1a9f5e421418302244de2a13b0f696822ea7a35a7", + "format": 1 + }, + { + "name": "plugins/modules/boot_image_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "276903501b0993ca78bd295d58245f8e050fc1cb6c94d0266c83838a3641dc33", + "format": 1 + }, + { + "name": "plugins/modules/bmc_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5e0732cd18a69ee5474a26e102cf9db70e9b1b12415c66fd8e002d212e2a41cc", + "format": 1 + }, + { + "name": "plugins/modules/bios_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "96b520a361c1ece1834433d1cf9b31e439370f4a833e7e7abcede105cab602ad", + "format": 1 + }, + { + "name": "plugins/modules/bios_import.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2430678493f5e87117156774b595c859fca66313604f1e6e1aae0514ad62b961", + "format": 1 + }, + { + "name": "plugins/modules/bios_export.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "300a7fc7f2c01b358b2996dca98a8d0c57a2d493343d7969a56889c942c9c58e", + "format": 1 + }, + { + "name": "plugins/modules/backup.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "1c8a872c695751664b651a5e6eaf29413cc8f99319f4108ea6e3691a561819f5", + "format": 1 + }, + { + "name": "plugins/modules/backplane_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5e4231bca87bce49e0254b15d746fb9e9fedd269094cead1a6773cc2a151b6d4", + "format": 1 + }, + { + "name": "plugins/modules/auto_capture_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d3b35380567cfbb15b3a0913754342224afc7a425b97fed4f6eb0a3ee9a43049", + "format": 1 + }, + { + "name": "plugins/modules/audit_log_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e18970d86f2252ea78cb492cd555b1b52584197e995820ee66c3677c446cd26d", + "format": 1 + }, + { + "name": "plugins/modules/alert_policy_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "fd8e3d3a1efcc2754985df6fd2d2db7f1a465463fc4389002a4e487e2467b5f5", + "format": 1 + }, + { + "name": "plugins/modules/ad_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c6ea0653f534f3e44695b24489a078dc23f8273d8d93c8386314a4d6d5622802", + "format": 1 + }, + { + "name": "plugins/modules/ad_group_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5464158ac246b7a79e0cacaec30548537a97d98c34591c88505e37c483977d81", + "format": 1 + }, + { + "name": "plugins/modules/ad_group.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d4d104c235db5573cf2528001e6e6a623db78fc03748bc4235e55717e0147bd2", + "format": 1 + }, + { + "name": "plugins/modules/add_ldisk.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "f202afa43a6efa26a8a319ae036bf617cbf71a91a47c581eaa715e720b498742", + "format": 1 + }, + { + "name": "plugins/modules/adapter_info.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b72ecb368fca72aab815fe97cfcee980b5072c594cb4c14a5dca6d868d8ac06f", + "format": 1 + }, + { + "name": "plugins/doc_fragments", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "plugins/doc_fragments/inmanage.py", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9838cd82c6b8fd1ec9d76607bbed78f0b221925d86c87190370ac7b9a0e449b8", + "format": 1 + }, + { + "name": "meta", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "meta/runtime.yml", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "db022ab321c223ac1a684a5c02ee490cc22278bed6b31f5a2348c9c1bf65ebea", + "format": 1 + }, + { + "name": "docs", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "docs/volt_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e179050f335d1ecbaed7f95dab946d88140650b69872f4b382877a65d85d68f3", + "format": 1 + }, + { + "name": "docs/virtual_media_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e8c0f3fb5d416f5e7abc0e51bd6fe086f634e9eafcce28f1b487bad135fde209", + "format": 1 + }, + { + "name": "docs/user_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2f22be44e61d77a60cea697edcaf4a97f01263cb7767743a337cc7eb3e892393", + "format": 1 + }, + { + "name": "docs/user_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "008f01b7653848973c9e7af44b7d0c162f703f04000739811be9b1fac770848d", + "format": 1 + }, + { + "name": "docs/user_group_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "14a7ad4fd40e4d9f9e968c35db3cc1cbce0fd31f3d9b3ef98ef78c826a7e6301", + "format": 1 + }, + { + "name": "docs/user_group_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e0669bb23b37abe33cabc796e2cd67db9abe1a2e4eb41d492d67e886c9bb2e32", + "format": 1 + }, + { + "name": "docs/update_psu_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "afb2e964bb48145e0cf80d0828efc5221e2fdb41f66572b0c0f19c1859246dee", + "format": 1 + }, + { + "name": "docs/update_fw_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2640d5584bb304dabd6c5b4f87902110b0b57cf4fa8d776b2592103e4ba37e44", + "format": 1 + }, + { + "name": "docs/update_cpld_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9aff3240f970e73249a891eb39beadaf39345bb6b56267487f5c887ecd034feb", + "format": 1 + }, + { + "name": "docs/uid_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8d685f0416278eacc0e4e64d409d993ed9a5176575dc7751f94aac5570d2ff0b", + "format": 1 + }, + { + "name": "docs/threshold_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "04fe22044102b753d2198e1e5d34ee9af7e5f28f3330f9fd07b33d0dbbf578ef", + "format": 1 + }, + { + "name": "docs/temp_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3500b0ef3ad1c219f9806abad4b66348a83b1ca38821eb5726a80685ebd4f098", + "format": 1 + }, + { + "name": "docs/system_log_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ecb3fc7e0d02097c06341471b929ced00de4089ee7e5af82ba8041126f46088c", + "format": 1 + }, + { + "name": "docs/support_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "82fa7d07dda555e259cef2e42935590dc4673b55849fae12394dce451f062e98", + "format": 1 + }, + { + "name": "docs/snmp_trap_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cc094d2eecdb64ce0f100622ecfd61fd852bf962ae33f532d9991d8016092227", + "format": 1 + }, + { + "name": "docs/snmp_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3b4a744afa3d8b533e841375072d28537c8bc3caaa0e42630a5e8e58d7a93a1c", + "format": 1 + }, + { + "name": "docs/smtp_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "f7587ffb91ba46e3a0b2587e13f03f0f7dc4c552ebbea74f258536d654b58c0c", + "format": 1 + }, + { + "name": "docs/session_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6b9ca0950fe0644137cf8729192760afa62c76104d1c6829396ba2f4ed8c46b9", + "format": 1 + }, + { + "name": "docs/service_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d608e82d48fe70067f5a41f6f6a3bcd1f736f8c9607d6da34652620adf6cc180", + "format": 1 + }, + { + "name": "docs/server_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "074e0ad76084ae25687342991b9928f7856d0086a88780fbe1afa88d0a3d874e", + "format": 1 + }, + { + "name": "docs/sensor_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c9dfb88145e0f3cfbd35b918179954f1533483845e618a00238cfced60346b49", + "format": 1 + }, + { + "name": "docs/self_test_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "504224bf2d2921f4f9127acfde7f25c14c53b3c9beb5626b0c26ec784c507baf", + "format": 1 + }, + { + "name": "docs/restore_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "50edc320631677cab94d570e5569db72921f7e16f38e1d247fe1b81f64567d29", + "format": 1 + }, + { + "name": "docs/reset_kvm_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "bd9c55da8ac2a220ca482f61bc7f643dcc55918b76de84b4227cc575436d4a9c", + "format": 1 + }, + { + "name": "docs/reset_bmc_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e7a97ee210f7b67786e73e2061eaf09dd53e42c5336f8d79ff166dfa08c7612e", + "format": 1 + }, + { + "name": "docs/raid_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8ae4ac6a413595885a4bb3eec0e64f4a2ade5705cae09e93d2d8f0fc74e7dbe6", + "format": 1 + }, + { + "name": "docs/psu_peak_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c533e18a6e17940e5715aeb653c1f9f2277c6ad922568a23928d58fcb0ec48f7", + "format": 1 + }, + { + "name": "docs/psu_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "570eaf0df16fbfbab47a067ebde80d4cca3ef31d62b90918c6f55013b7803db5", + "format": 1 + }, + { + "name": "docs/psu_config_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "490822e0a1389ecc8af7e6dbd7308671a537cde722130ebb3bd2c7017b464098", + "format": 1 + }, + { + "name": "docs/preserve_config_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "72e6346b9f48b949110d763ad748e7ff3edb46293340dad5a6697a4cce19e7d1", + "format": 1 + }, + { + "name": "docs/power_status_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "123d66430dc44f0b490fa330e3fe5c485000e6c5dadddccf7fa599ea319775f1", + "format": 1 + }, + { + "name": "docs/power_restore_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7856fd51685baca7332320a2eeb20413167a36fce4bb23bf8a59187bb8d1d7e9", + "format": 1 + }, + { + "name": "docs/power_consumption_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a9a41334f8be277b2f0fdd9bd6bb80ab43ebdff8f2ebd8060c42df995af55acb", + "format": 1 + }, + { + "name": "docs/power_budget_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3de2c26fff3a878734c452870e503a26720d6e14aa67b15e786850ec968b2533", + "format": 1 + }, + { + "name": "docs/pdisk_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "01cd176a614127adcd2ff51c79dc3f09180a49b926bcb6e6bd8e5b7c0f7cd0ca", + "format": 1 + }, + { + "name": "docs/pcie_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "39149963084cd465d4133cf38ba31e7ff90662250814c6a5f9f9335bed2ba696", + "format": 1 + }, + { + "name": "docs/onboard_disk_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "350f9f08300a424507174713892261e3fe44565b1e9faa8eaf2af731c6e00234", + "format": 1 + }, + { + "name": "docs/ntp_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d85c95e603f713ee9846fac6c0901f43c9a83917f9acf6b9c2588f9fdcb3a05f", + "format": 1 + }, + { + "name": "docs/network_link_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "aff29d93bb7ee426e2fef7ad558585767b8f170f7ba78036b6f0629d59c66f6e", + "format": 1 + }, + { + "name": "docs/network_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8aca51459244dae9c3f8203a673197bae70c6516e385473c6197909e8a0a4306", + "format": 1 + }, + { + "name": "docs/network_bond_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3f65c4997fd3dba65caeae7baddbfe77fdbfb3596608753e34b0ba3a4c880ac9", + "format": 1 + }, + { + "name": "docs/ncsi_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c998595ec25f01c5b9dbca11f4c9be0e66195613341c86464096edac1f901b78", + "format": 1 + }, + { + "name": "docs/mem_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a33b9802ad02bd84612f0549154e429d9ba3c23372a4f5a91b1e037376c9066c", + "format": 1 + }, + { + "name": "docs/media_instance_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a06f0df7c3648cb0bde13222a8c0869c845d626c9c2f1b8bcc111d99b8e82476", + "format": 1 + }, + { + "name": "docs/log_setting_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9d6101c3154062835e7d9a645276e1572528b3f7dc158279f4eb333ab8cbf047", + "format": 1 + }, + { + "name": "docs/ldisk_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3ed53e9236c2208a8ac150c2adab5d81b6b448cc57570afe65e9aedeea04a87a", + "format": 1 + }, + { + "name": "docs/ldap_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "15e7789037d9478e46e3974b299932105b6bb6bb7837df9fd1df6e9296660eca", + "format": 1 + }, + { + "name": "docs/ldap_group_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "916d4212ef62d942d311aa1d4bca61044607f94fba2e00b1f4adb2828f76bd7a", + "format": 1 + }, + { + "name": "docs/ldap_group_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b3f93a6b0238d903296b8361d0104e6ed0179447c68675e35fe1acd74111f23a", + "format": 1 + }, + { + "name": "docs/kvm_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "367f23f4ceb45b6c1b168e84519ba925b19bdec0da83d93360a58453d8d61ee7", + "format": 1 + }, + { + "name": "docs/index.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4391a6a8bc5a6376e5c6daa2aee41b46a16c028f5fc8b4c1f0a0462adf988898", + "format": 1 + }, + { + "name": "docs/hba_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "22cb937877cbb2dd9096beabf0918be8fa88537a99bf4763577c5d1ed81fa190", + "format": 1 + }, + { + "name": "docs/hard_disk_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "985637f6f62f92aa32f8eff4ad0c5b323ae3f066319e9b430b9b4a21096f7133", + "format": 1 + }, + { + "name": "docs/gpu_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "59b750a1cbb333e72af499668f34599b78743f95b782136ee0ea51eeee70b5e7", + "format": 1 + }, + { + "name": "docs/fw_version_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "01f43eeb1b5a439fcd0c99f8217a67f46c4c334351299915159d9b28a5fa481f", + "format": 1 + }, + { + "name": "docs/fru_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "089de696dddfcdbc0d9a0b653512d8d54b5f6f2285235b8f0a22696c3e784342", + "format": 1 + }, + { + "name": "docs/fan_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9e0bc2d17e460c53e7e459b408f987b73b2bb4b1ffd50a9b4e5b1a7106afcedd", + "format": 1 + }, + { + "name": "docs/event_log_policy_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b10820647f708349e7ad298fa7e45efb0970ed37fa0210705aab9e9fd112b715", + "format": 1 + }, + { + "name": "docs/event_log_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e63056de24eab7d203d1ea1b6f1d76f4b5148cb007fd8b42e5f0617e66c79b2e", + "format": 1 + }, + { + "name": "docs/edit_vlan_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0598a8b7f7fa4006eb4994c8c0ff088a49a55a843809980e420fca23d999eabc", + "format": 1 + }, + { + "name": "docs/edit_virtual_media_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ad12263c71cf2b21be7857fa5fa77d9bb19bd6c6e74f8e3104644c3ace5d0a69", + "format": 1 + }, + { + "name": "docs/edit_uid_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "95de2c567b124855224fba2655e74036936f43c5ca9e466b0639d66493273835", + "format": 1 + }, + { + "name": "docs/edit_threshold_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3b9cc8e0bb941fd407cfced17cf70747a4cdec93b119d8912cd2eeba5d6cf992", + "format": 1 + }, + { + "name": "docs/edit_snmp_trap_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c81fbbcadc0cc543a3272b1dd16366994fa96dd34a94fb4847e0e93d9e0374b7", + "format": 1 + }, + { + "name": "docs/edit_snmp_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "30510f9b2957cc099352e3305c26243b20f6ba5317ac7fa659e6c6cbc6e22453", + "format": 1 + }, + { + "name": "docs/edit_smtp_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7b2fd715860b1ecdb8766e7e6746fa4376223c53ec50cc55365d74ece737fb91", + "format": 1 + }, + { + "name": "docs/edit_smtp_dest_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2e2d9cff0e56dcb573294173a6673528ff0290259771f96cb663d2e1b297ae3b", + "format": 1 + }, + { + "name": "docs/edit_smtp_com_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e2682dfdfa1c5b612fd22880934215253e6e567b892e3258698e7be9f7c2e682", + "format": 1 + }, + { + "name": "docs/edit_service_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "539f136935f01baeae05ce853277d43cf89835518fd6117152b1efa3806f01f0", + "format": 1 + }, + { + "name": "docs/edit_restore_factory_default_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5cbff38cecd47a9c2da7f852381f7f776f73f451ab478b63f862d16d87072d18", + "format": 1 + }, + { + "name": "docs/edit_psu_peak_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "23c1e859ada7858b5b25daf19dde55edb631147827ce7a83bcceeee967bc22c8", + "format": 1 + }, + { + "name": "docs/edit_psu_config_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c9fcc01d964bc6cf49e2b51486a7d8e413e61af74a2035e27a3edc6d7773caac", + "format": 1 + }, + { + "name": "docs/edit_preserve_config_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "426d16bc86e81d9d5feffb1e060dd47d84158091fa0f1670e0800e07a666f113", + "format": 1 + }, + { + "name": "docs/edit_power_status_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2cd6d3e08e615e5b697194ae99384781d2b430fd2d545d734716b582acbeb45b", + "format": 1 + }, + { + "name": "docs/edit_power_restore_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7ea829726762a9c0902285a87076a7f1aa05437c3e32420ce31a7ed7571e88ab", + "format": 1 + }, + { + "name": "docs/edit_power_budget_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "042427ff7c118776db9da8f49c3c45409fa2cafd368f6c8c6e07ad3f39136ba8", + "format": 1 + }, + { + "name": "docs/edit_pdisk_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "117bc47bda44c0e94bae6d255462e5094656f398d9c4c7928a08e9a08e6de8a2", + "format": 1 + }, + { + "name": "docs/edit_ntp_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "66bd0321204ba88154351807a155a96044ab992288d649ac408ec8a7c2256874", + "format": 1 + }, + { + "name": "docs/edit_network_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "1694d59269a0a8dbb8134f95e933e2d1174adf2876183ca8b20c3033c80799aa", + "format": 1 + }, + { + "name": "docs/edit_network_link_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0d7f47e3c5331b3c8996386ad88abad5b605f23936555becda7086cb3db38354", + "format": 1 + }, + { + "name": "docs/edit_network_bond_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e578a77f93d99306ced829b0e38a10b70ae47457bf3dff3d4c4fee2b222a9418", + "format": 1 + }, + { + "name": "docs/edit_ncsi_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7a72c216935f6f2e4fd1e64dcc81faba1809a17aecd14fa2bed3e1238dcae11b", + "format": 1 + }, + { + "name": "docs/edit_media_instance_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "af1df23a72b3dd96a5be73c3f5a1bee52e53eac8a819beed2c9a54bc65c77fd3", + "format": 1 + }, + { + "name": "docs/edit_manual_capture_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c0e5786f0b093e413d3655622ac535abd80b4d081251d4c80ef12a0bcb6da5af", + "format": 1 + }, + { + "name": "docs/edit_m6_log_setting_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4ef34cb041a60bb2cbf84d781cbaa15178c39e1e06ed12519ff9d70a8b106644", + "format": 1 + }, + { + "name": "docs/edit_log_setting_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "982a3b9d5c35401420d8e715aa558a4a4322fe896a2c37c7b327b791ff3dd82f", + "format": 1 + }, + { + "name": "docs/edit_ldisk_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "685e7d3b90a816300cf0c7f45bb7a40c8bc02a35406d7a378caa3fca84654de3", + "format": 1 + }, + { + "name": "docs/edit_ldap_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a0000523d9288537a447df8c7e677d499562aa6f5b72d82bc1488f4810ead42e", + "format": 1 + }, + { + "name": "docs/edit_kvm_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c4ed56b43287be8b53a1ddbba48046036a19e84728975a72eb09c71cc867e67e", + "format": 1 + }, + { + "name": "docs/edit_ipv6_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "1ca8a6e0008b230a29d79c10b5c609b5ceded6343e7a39c716e412420cd3ebcc", + "format": 1 + }, + { + "name": "docs/edit_ipv4_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2b1c50ca731ec4581ebe61961405c179bb53e2031f46fbd36476d4fe523da613", + "format": 1 + }, + { + "name": "docs/edit_fru_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0b66278e5434be03f7c4d26405544f9acaf7d3bec0a41b519d16fea4688f92dd", + "format": 1 + }, + { + "name": "docs/edit_fan_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "955096ca90f786accf125cdd4986f60a19722b5b4129c77be1d723f685533fbc", + "format": 1 + }, + { + "name": "docs/edit_event_log_policy_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "11171ff559dcf7fb7b21c96d7ba878a9a44d59b7e83ad3ff564b2bf3ff981482", + "format": 1 + }, + { + "name": "docs/edit_dns_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "83ffd520cb18800f0eab4a0c16cedff05df38faad0fc24898a8afc529559fb4e", + "format": 1 + }, + { + "name": "docs/edit_connect_media_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "90c8858b811876e612c638b63f4cc659109200998e6fff6538571ec40ce289f9", + "format": 1 + }, + { + "name": "docs/edit_boot_option_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "af8426febf04a18f63ce41480caf2187d60709d462a8a47734d6e9dd36caf0a3", + "format": 1 + }, + { + "name": "docs/edit_boot_image_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "03e88b57407dc613f543deba52a6d99c99e0ca208bda6e609f6e220186ed312e", + "format": 1 + }, + { + "name": "docs/edit_bios_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e52e1aa956a91d997c6d02bcfbbf2c9df098ae223b62880e67cab3fe0d39d549", + "format": 1 + }, + { + "name": "docs/edit_auto_capture_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3059e2b3f70c5c7c2484ce343a8f173d72051822800c89683710633f07114033", + "format": 1 + }, + { + "name": "docs/edit_alert_policy_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "69357ca0f639b0ef7ed145d0849f79fca4645641406f31dddba504464106c285", + "format": 1 + }, + { + "name": "docs/edit_ad_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7155cd64a32adf44ac23e54e766da69783ffdf73cd14b2f5df0994e318393f38", + "format": 1 + }, + { + "name": "docs/download_manual_screenshot_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "96d9d6ccc42174abb044cc36b348b110df01f269df552d4122b4001947265bc6", + "format": 1 + }, + { + "name": "docs/download_auto_screenshot_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "25545b1c46429dc95c96e5570579cee42eca02f1d06b2eb8e7e3aea549deb070", + "format": 1 + }, + { + "name": "docs/dns_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b56cca1f510c0ae3cb0028c5d192cea449ff968647186a982edaf92c3c3a1723", + "format": 1 + }, + { + "name": "docs/del_session_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d0b12377666d295608dba1560be067a42940fb7a8f00a95004d62f7e9630b3ff", + "format": 1 + }, + { + "name": "docs/cpu_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "886b8e5d793d40912c76c6a3f9eebca1feb6e7e7b092189988e43d3ad8eacd5c", + "format": 1 + }, + { + "name": "docs/connect_media_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cf9f4c72ac92ae5439eac23df6b103998ae31e836f374a7e695cf2b2cbf3d648", + "format": 1 + }, + { + "name": "docs/collect_log_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "64a28d51d255d614d12aa64accd99789a817a20511d25652ff8bbb093c45dcc0", + "format": 1 + }, + { + "name": "docs/collect_blackbox_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6651f67d32ba0b8d091071f7e3130b8fa4e85aaa0df7458cce10ef43b3029187", + "format": 1 + }, + { + "name": "docs/clear_system_log_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "7c1e176fa570aefba5592de6b896fe99a0902b0ffa0d28accea03765c454b8be", + "format": 1 + }, + { + "name": "docs/clear_event_log_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "b3dd92e593af2add73e273a371eea0a70d4e9bb0026e0f4057b163a7e75e2b5d", + "format": 1 + }, + { + "name": "docs/clear_audit_log_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "2b202f1e8fbdb576e0d45c7e4ca730d4ce13d40efdedad64846d89e602bff183", + "format": 1 + }, + { + "name": "docs/boot_option_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "c48fb41f43812ae4408abe50f0f4004b70c156f7f37bf0d6869e2a93994bbe29", + "format": 1 + }, + { + "name": "docs/boot_image_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "5c4e724f2ac6b11311ea81e0d02c31c681c9c0993c1a66e8237b7e812fcb6a71", + "format": 1 + }, + { + "name": "docs/bmc_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9aa44d89747e7a99bcbd3929a8e294b7ee5ee6ec5007c544b5c7ceb529db4126", + "format": 1 + }, + { + "name": "docs/bios_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "009acee898ae94772d90cf4a4c6dd61c2ab0cac661ff26b9467a30739567af0d", + "format": 1 + }, + { + "name": "docs/bios_import_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "03ceb7843b8b74de734f68737a4c54d999d4a8b15ad564f9db405cb2330f1153", + "format": 1 + }, + { + "name": "docs/bios_export_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "608db6425ad9914782e0b178b400fc121999b397314bcee5d7b302a8dc1f572b", + "format": 1 + }, + { + "name": "docs/backup_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "d60bb2008d2ef66f06371f0716681681a8818fe322185bb3fe6a8aeb593f6962", + "format": 1 + }, + { + "name": "docs/backplane_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8f942ab36cca1d873571ffbb84fa57dcc2375c65c21d1bb447f7f6feddf73f3b", + "format": 1 + }, + { + "name": "docs/auto_capture_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "93d771bbd209c2cc3de644be6497a370bbf449919f0bddd515f078f5c2cc9a42", + "format": 1 + }, + { + "name": "docs/audit_log_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e2bd4e6c8890583a063bcf718a38704225b1dca9c6d8d6070babfb906e138474", + "format": 1 + }, + { + "name": "docs/alert_policy_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "8c446a5273f138792a20457ca9bfebaae9f3e2d636f0c596716d6653f1d0309b", + "format": 1 + }, + { + "name": "docs/ad_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "225177902f41f1a2705ee571b8017ffcea9a55f775b061731968b882a94e905b", + "format": 1 + }, + { + "name": "docs/ad_group_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "a9009fffd63bd5220756b94d25b56cd25417ce5a6318cd792de55c92e678f16e", + "format": 1 + }, + { + "name": "docs/ad_group_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "36abd8d5d233f1eeca2b966a25836e968ffa1e336e3799079220ab76f703d124", + "format": 1 + }, + { + "name": "docs/add_ldisk_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "4f052142cc9eaffe23aa43bd893eeb6ed664166ddd61f8df79dd54af0e210a38", + "format": 1 + }, + { + "name": "docs/adapter_info_module.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "9bbd89f6f65ef508af44e810223ae37a668385e88624eb6a2c1a74e7a277d71e", + "format": 1 + }, + { + "name": "changelogs", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "changelogs/fragments", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": "changelogs/fragments/.keep", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", + "format": 1 + }, + { + "name": "changelogs/config.yaml", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "93e6532aa24bd6b494fb52a349736e1595e133e7b2c6ff8197dbf35c31879d69", + "format": 1 + }, + { + "name": "changelogs/changelog.yaml", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "6eda1c1af43be8a8e5fc17b95b4689c5a3a117ec7d1d7d3d18a9544101c1b19e", + "format": 1 + }, + { + "name": ".github", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": ".github/workflows", + "ftype": "dir", + "chksum_type": null, + "chksum_sha256": null, + "format": 1 + }, + { + "name": ".github/workflows/ansible-test.yml", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "bd598ce9c34e9c78ed5d1a3e1e4b13c07fac7ff33b359688242ee1576c95033a", + "format": 1 + }, + { + "name": ".github/settings.yml", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cb31353134cff7d91b546a03cc6fec7caaf0dba62079ea66776e2994461e6c7b", + "format": 1 + }, + { + "name": "requirements.txt", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "ef4f74801ee735132cee77b4d649b81c7f95233d14aa409f565250d903134313", + "format": 1 + }, + { + "name": "README.md", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "cad2d451c9cae4492ec532ac7996628c08b587740f4a5bfb5f329f26594cf67c", + "format": 1 + }, + { + "name": "LICENSE", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "3972dc9744f6499f0f9b2dbf76696f2ae7ad8af9b23dde66d6af86c9dfb36986", + "format": 1 + }, + { + "name": "CODE_OF_CONDUCT.md", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "14ec928234a7ed52bf8b458d31e4862335111e477e4dbe7fb543686c24115140", + "format": 1 + }, + { + "name": "CHANGELOG.rst", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "bcfdccaaa849ed861f7735ad47c489cbd7254b1c83240857820d13820bde4d9d", + "format": 1 + } + ], + "format": 1 +}
\ No newline at end of file diff --git a/ansible_collections/ieisystem/inmanage/LICENSE b/ansible_collections/ieisystem/inmanage/LICENSE new file mode 100644 index 000000000..f288702d2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/ansible_collections/ieisystem/inmanage/MANIFEST.json b/ansible_collections/ieisystem/inmanage/MANIFEST.json new file mode 100644 index 000000000..a54b7638e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/MANIFEST.json @@ -0,0 +1,36 @@ +{ + "collection_info": { + "namespace": "ieisystem", + "name": "inmanage", + "version": "2.0.0", + "authors": [ + "Baoshan Wang <wangbaoshan@ieisystem.com>" + ], + "readme": "README.md", + "tags": [ + "ieisystem", + "inmanage", + "server", + "manager", + "tools" + ], + "description": "ieisystem Server supports ansible management device.", + "license": [ + "GPL-2.0-or-later" + ], + "license_file": null, + "dependencies": {}, + "repository": "https://github.com/ieisystem/ieisystem.inmanage", + "documentation": "https://ieisystem.github.io/ieisystem.inmanage-docs/index.html", + "homepage": "https://github.com/ieisystem/ieisystem.inmanage", + "issues": "https://github.com/ieisystem/ieisystem.inmanage/issues" + }, + "file_manifest_file": { + "name": "FILES.json", + "ftype": "file", + "chksum_type": "sha256", + "chksum_sha256": "0bb56c1b70e10b4035ac5d0f93771aa095317a35e95b3ac42e8ecf042f40687a", + "format": 1 + }, + "format": 1 +}
\ No newline at end of file diff --git a/ansible_collections/ieisystem/inmanage/README.md b/ansible_collections/ieisystem/inmanage/README.md new file mode 100644 index 000000000..eb3621f11 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/README.md @@ -0,0 +1,92 @@ +# ieisystem InManage Collection + +This repo contains the `ieisystem.inmanage` Ansible Collection. Collections are used to manage common IEIT servers, and Basic management of the server based on restful interface. Including server BMC configuration, firmware upgrade, BIOS configuration and other functions. + +. + +## Tested with Ansible + +Tested with the current Ansible 2.10 releases and the current development version of Ansible. Ansible versions before 2.10 are not supported. + +## External requirements + +Circumstance instruction: +Ansible module is suitable for ansible version 2.10 + +Main steps: + +* Install Ansible 2.10 +* Install inManage: pip install inManage +<!--- A step-by-step reproduction of the problem is helpful if there is no related issue --> +Thes modules require the following to be installed on the control node: + +* Python 3.7 or later +* [Ansible](http://www.ansible.com) 2.10 or later +* [ieisystem support] [inManage](https://github.com/ieisystem/inManage) 1.1.0 or later + +## Included content + +Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/ieisystem/inmanage) + +## Using this collection + +Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI: + + ansible-galaxy collection install ieisystem.inmanage + +You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format: + +```yaml +collections: +- name: ieisystem.inmanage +``` + +See [Ansible Using collections](https://ieisystem.github.io/ieisystem.inmanage-docs/index.html) for more details. + +## Contributing to this collection + +If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. + +You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible ieisystem.inmanage Guide](https://ieisystem.github.io/ieisystem.inmanage-docs/index.html). + +### Running tests + +See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections). + +### Communication + +wangbaoshan@ieisystem.com + + +### Publishing New Version + +Basic instructions without release branches: + +1. Create `changelogs/fragments/<version>.yml` with `release_summary:` section (which must be a string, not a list). +2. Run `antsibull-changelog release --collection-flatmap yes` +3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed. +4. Tag the commit with `<version>`. Push changes and tag to the main repository. + +## Release notes + +See the [changelog](https://github.com/ieisystem/ieisystem.inmanage/blob/main/CHANGELOG.rst). + +## Roadmap + +See [this issue](https://github.com/ieisystem/ieisystem.inmanage/issues/2) for information on releasing, versioning and deprecation. + +In general, we plan to release a major version every year, and minor versions every three months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes. + + +## More information + +- [Ansible Collection overview](https://github.com/ansible-collections/overview) +- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html) +- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html) +- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) + +## Licensing + +GNU General Public License v3.0 or later. + +See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. diff --git a/ansible_collections/ieisystem/inmanage/changelogs/changelog.yaml b/ansible_collections/ieisystem/inmanage/changelogs/changelog.yaml new file mode 100644 index 000000000..9a9b61b38 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/changelogs/changelog.yaml @@ -0,0 +1,453 @@ +ancestor: null +releases: + 1.0.0: + changes: + major_changes: + - add all modules. + minor_changes: + - Change the referenced sdk name to inManage. + - Change the value of tags in galaxy.xml. + - Example Change the version to 1.0.0. + - Modify the release plan link in the readme file. + fragments: + - 1-add_modules.yaml + - 2-edit_version1.0.0.yaml + - 3-edit_readme.yaml + - 4-edit_inmanage_sdk.yaml + - 5-edit_galaxy_xml.yaml + modules: + - description: Manage active directory group information + name: ad_group + namespace: '' + - description: Get active directory group information + name: ad_group_info + namespace: '' + - description: Get active directory information + name: ad_info + namespace: '' + - description: Get adapter information + name: adapter_info + namespace: '' + - description: Create logical disk + name: add_ldisk + namespace: '' + - description: Get alert policy + name: alert_policy_info + namespace: '' + - description: Get BMC audit log information + name: audit_log_info + namespace: '' + - description: Get auto capture screen information + name: auto_capture_info + namespace: '' + - description: Get disk backplane information + name: backplane_info + namespace: '' + - description: Backup server settings + name: backup + namespace: '' + - description: Export BIOS config + name: bios_export + namespace: '' + - description: Import BIOS config + name: bios_import + namespace: '' + - description: Get BIOS setup + name: bios_info + namespace: '' + - description: Get BMC information + name: bmc_info + namespace: '' + - description: Get bmc boot image information + name: boot_image_info + namespace: '' + - description: Get BIOS boot options + name: boot_option_info + namespace: '' + - description: Clear BMC audit log + name: clear_audit_log + namespace: '' + - description: Clear event log + name: clear_event_log + namespace: '' + - description: Clear BMC system log + name: clear_system_log + namespace: '' + - description: Collect blackbox log + name: collect_blackbox + namespace: '' + - description: Collect logs + name: collect_log + namespace: '' + - description: Get remote images redirection information + name: connect_media_info + namespace: '' + - description: Get CPU information + name: cpu_info + namespace: '' + - description: Delete session + name: del_session + namespace: '' + - description: Get dns information + name: dns_info + namespace: '' + - description: Download auto screenshots + name: download_auto_screenshot + namespace: '' + - description: Download manual screenshots + name: download_manual_screenshot + namespace: '' + - description: Set active directory information + name: edit_ad + namespace: '' + - description: Set alert policy + name: edit_alert_policy + namespace: '' + - description: Set auto capture screen + name: edit_auto_capture + namespace: '' + - description: Set BIOS setup attributes + name: edit_bios + namespace: '' + - description: Set bmc boot image + name: edit_boot_image + namespace: '' + - description: Set BIOS boot options + name: edit_boot_option + namespace: '' + - description: Start/Stop virtual media Image + name: edit_connect_media + namespace: '' + - description: Set dns information + name: edit_dns + namespace: '' + - description: Set event log policy + name: edit_event_log_policy + namespace: '' + - description: Set fan information + name: edit_fan + namespace: '' + - description: Set fru settings + name: edit_fru + namespace: '' + - description: Set ipv4 information + name: edit_ipv4 + namespace: '' + - description: Set ipv6 information + name: edit_ipv6 + namespace: '' + - description: Set KVM + name: edit_kvm + namespace: '' + - description: Set ldap information + name: edit_ldap + namespace: '' + - description: Set logical disk + name: edit_ldisk + namespace: '' + - description: Set bmc system and audit log setting + name: edit_log_setting + namespace: '' + - description: Set bmc system and audit log setting + name: edit_m6_log_setting + namespace: '' + - description: Set manual capture screen + name: edit_manual_capture + namespace: '' + - description: Set Virtual Media Instance + name: edit_media_instance + namespace: '' + - description: Set ncsi information + name: edit_ncsi + namespace: '' + - description: Set network information + name: edit_network + namespace: '' + - description: Set network bond + name: edit_network_bond + namespace: '' + - description: Set network link + name: edit_network_link + namespace: '' + - description: Set NTP + name: edit_ntp + namespace: '' + - description: Set physical disk + name: edit_pdisk + namespace: '' + - description: Set power budget information + name: edit_power_budget + namespace: '' + - description: Set power restore information + name: edit_power_restore + namespace: '' + - description: Set power status information + name: edit_power_status + namespace: '' + - description: Set preserve config + name: edit_preserve_config + namespace: '' + - description: Set psu config information + name: edit_psu_config + namespace: '' + - description: Set psu peak information + name: edit_psu_peak + namespace: '' + - description: Set preserver config + name: edit_restore_factory_default + namespace: '' + - description: Set service settings + name: edit_service + namespace: '' + - description: Set SMTP information + name: edit_smtp + namespace: '' + - description: Set SMTP information + name: edit_smtp_com + namespace: '' + - description: Set SMTP information + name: edit_smtp_dest + namespace: '' + - description: Set snmp + name: edit_snmp + namespace: '' + - description: Set snmp trap + name: edit_snmp_trap + namespace: '' + - description: Set threshold information + name: edit_threshold + namespace: '' + - description: Set UID + name: edit_uid + namespace: '' + - description: Set virtual media + name: edit_virtual_media + namespace: '' + - description: Set vlan information + name: edit_vlan + namespace: '' + - description: Get event log information + name: event_log_info + namespace: '' + - description: Get event log policy information + name: event_log_policy_info + namespace: '' + - description: Get fan information + name: fan_info + namespace: '' + - description: Get fru information + name: fru_info + namespace: '' + - description: Get firmware version information + name: fw_version_info + namespace: '' + - description: Get GPU information + name: gpu_info + namespace: '' + - description: Get hard disk information + name: hard_disk_info + namespace: '' + - description: Get CPU information + name: hba_info + namespace: '' + - description: Get KVM information + name: kvm_info + namespace: '' + - description: Manage ldap group information + name: ldap_group + namespace: '' + - description: Get ldap group information + name: ldap_group_info + namespace: '' + - description: Get ldap information + name: ldap_info + namespace: '' + - description: Get logical disks information + name: ldisk_info + namespace: '' + - description: Get bmc log setting information + name: log_setting_info + namespace: '' + - description: Get Virtual Media Instance information + name: media_instance_info + namespace: '' + - description: Get memory information + name: mem_info + namespace: '' + - description: Get ncsi information + name: ncsi_info + namespace: '' + - description: Get network bond information + name: network_bond_info + namespace: '' + - description: Get network information + name: network_info + namespace: '' + - description: Get network link information + name: network_link_info + namespace: '' + - description: Get NTP information + name: ntp_info + namespace: '' + - description: Get onboard disks information + name: onboard_disk_info + namespace: '' + - description: Get PCIE information + name: pcie_info + namespace: '' + - description: Get physical disks information + name: pdisk_info + namespace: '' + - description: Get power budget information + name: power_budget_info + namespace: '' + - description: Get power consumption information + name: power_consumption_info + namespace: '' + - description: Get power restore information + name: power_restore_info + namespace: '' + - description: Get power status information + name: power_status_info + namespace: '' + - description: Get preserve config information + name: preserve_config_info + namespace: '' + - description: Get psu config information + name: psu_config_info + namespace: '' + - description: Get psu information + name: psu_info + namespace: '' + - description: Get psu peak information + name: psu_peak_info + namespace: '' + - description: Get RAID/HBA card and controller information + name: raid_info + namespace: '' + - description: BMC reset + name: reset_bmc + namespace: '' + - description: KVM reset + name: reset_kvm + namespace: '' + - description: Restore server settings + name: restore + namespace: '' + - description: Get self test information + name: self_test_info + namespace: '' + - description: Get sensor information + name: sensor_info + namespace: '' + - description: Get server status information + name: server_info + namespace: '' + - description: Get service information + name: service_info + namespace: '' + - description: Get online session information + name: session_info + namespace: '' + - description: Get SMTP information + name: smtp_info + namespace: '' + - description: Get snmp get/set information + name: snmp_info + namespace: '' + - description: Get snmp trap information + name: snmp_trap_info + namespace: '' + - description: Get support information + name: support_info + namespace: '' + - description: Get BMC system log information + name: system_log_info + namespace: '' + - description: Get temp information + name: temp_info + namespace: '' + - description: Get threshold information + name: threshold_info + namespace: '' + - description: Get UID information + name: uid_info + namespace: '' + - description: Update CPLD + name: update_cpld + namespace: '' + - description: Update firmware + name: update_fw + namespace: '' + - description: Update PSU + name: update_psu + namespace: '' + - description: Manage user + name: user + namespace: '' + - description: Manage user group + name: user_group + namespace: '' + - description: Get user group information + name: user_group_info + namespace: '' + - description: Get user information + name: user_info + namespace: '' + - description: Get Virtual Media information + name: virtual_media_info + namespace: '' + - description: Get volt information + name: volt_info + namespace: '' + release_date: '2023-11-08' + 1.1.0: + changes: + minor_changes: + - Fix any issues in your module that don't meet the ansible module format and + documentation requirements. + - Modify the CI test file to add Ansile-2.16 and python 3.12 tests. + - Modify the collection description in the README.md file. + fragments: + - 7-edit_readme_and_CI.yaml + - 8-edit_documentation.yml + release_date: '2024-03-12' + 1.1.1: + changes: + minor_changes: + - Change edit_alert_policy module description information does not have the + first letter capitalization problem. + - Fix problems such as typos or grammatical errors in the document. + - Modify the readme.md information about installing supported modules. + fragments: + - 10-edit_doc_spell.yaml + - 11-edit_doc_first_letter.yaml + release_date: '2024-03-25' + 1.2.0: + changes: + bugfixes: + - Add ansible 2.17 version tests to our CI test scripts. + - Delete the useless __init__.py file in modules and module_utils. + - Modify the add_ldisk, edit_ldisk, and edit_pdisk module.rst documents (https://github.com/ieisystem/ieisystem.inmanage/pull/16). + removed_features: + - add_ldisk - Delete the ``add_ldisk.info`` parameter. Use ``ieisystem.inmanage.pdisk_info`` + instead (https://github.com/ieisystem/ieisystem.inmanage/pull/15). + - edit_ldisk - Delete the ``edit_ldisk.info`` parameter. Use ``ieisystem.inmanage.ldisk_info`` + instead (https://github.com/ieisystem/ieisystem.inmanage/pull/15). + - edit_pdisk - Delete the ``edit_pdisk.info`` parameter. Use ``ieisystem.inmanage.pdisk_info`` + instead (https://github.com/ieisystem/ieisystem.inmanage/pull/15). + fragments: + - 13-delete_init_file.yml + - 14-ansible2.17_added_for_CI_testing.yml + - 15-remove_modules_info.yml + - 16-edit_docs.yml + release_date: '2024-04-17' + 1.2.1: + changes: + bugfixes: + - Change the example gather_facts no to false(https://github.com/ieisystem/ieisystem.inmanage/pull/18). + - Delete the unwanted links.yml file (https://github.com/ieisystem/ieisystem.inmanage/pull/19). + fragments: + - 18-edit_example_gather_facts.yml + - 19-delete_links.yml + release_date: '2024-04-24' diff --git a/ansible_collections/ieisystem/inmanage/changelogs/config.yaml b/ansible_collections/ieisystem/inmanage/changelogs/config.yaml new file mode 100644 index 000000000..08c3ba7cc --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/changelogs/config.yaml @@ -0,0 +1,29 @@ +changelog_filename_template: ../CHANGELOG.rst +changelog_filename_version_depth: 0 +changes_file: changelog.yaml +changes_format: combined +keep_fragments: false +mention_ancestor: true +new_plugins_after_name: removed_features +notesdir: fragments +prelude_section_name: release_summary +prelude_section_title: Release Summary +sections: +- - major_changes + - Major Changes +- - minor_changes + - Minor Changes +- - breaking_changes + - Breaking Changes / Porting Guide +- - deprecated_features + - Deprecated Features +- - removed_features + - Removed Features (previously deprecated) +- - security_fixes + - Security Fixes +- - bugfixes + - Bugfixes +- - known_issues + - Known Issues +title: CHANGE THIS IN changelogs/config.yaml! +trivial_section_name: trivial diff --git a/ansible_collections/ieisystem/inmanage/changelogs/fragments/.keep b/ansible_collections/ieisystem/inmanage/changelogs/fragments/.keep new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/changelogs/fragments/.keep diff --git a/ansible_collections/ieisystem/inmanage/docs/ad_group_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ad_group_info_module.rst new file mode 100644 index 000000000..797a4c122 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ad_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ad_group_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ad_group_info -- Get active directory group information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ad_group_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get active directory group information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get active directory group information" + ieisystem.inmanage.ad_group_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ad_group_module.rst b/ansible_collections/ieisystem/inmanage/docs/ad_group_module.rst new file mode 100644 index 000000000..b751c17fc --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ad_group_module.rst @@ -0,0 +1,431 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ad_group_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ad_group -- Manage active directory group information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ad_group`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage active directory group information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-domain"></div> + <b>domain</b> + <a class="ansibleOptionLink" href="#parameter-domain" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Enter the Role Group Domain. This is the domain where the role group is located.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm"></div> + <b>kvm</b> + <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>This field provides access to KVM for AD authenticated role group user.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-name"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Enter the Role Group Name. This name identifies the role group in Active Directory.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-pri"></div> + <b>pri</b> + <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>administrator</li> + <li>user</li> + <li>operator</li> + <li>oem</li> + <li>none</li> + </ul> + </td> + <td> + <div>Enter the Role Group Privilege. This is the level of privilege to be assigned for this role group.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>present</b> ←</div></li> + <li>absent</li> + </ul> + </td> + <td> + <div>Whether the active directory group should exist or not, taking action if the state is different from what is stated.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-vm"></div> + <b>vm</b> + <a class="ansibleOptionLink" href="#parameter-vm" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>This field provides access to VMedia for AD authenticated role group user.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add active directory group information" + ieisystem.inmanage.ad_group: + state: "present" + name: "wbs" + domain: "test.com" + pri: "administrator" + kvm: "enable" + vm: "disable" + provider: "{{ inmanage }}" + + - name: "Set active directory group information" + ieisystem.inmanage.ad_group: + state: "present" + name: "wbs" + pri: "user" + kvm: "disable" + provider: "{{ inmanage }}" + + - name: "Delete active directory group information" + ieisystem.inmanage.ad_group: + state: "absent" + name: "wbs" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ad_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ad_info_module.rst new file mode 100644 index 000000000..3e414f7ae --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ad_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ad_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ad_info -- Get active directory information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ad_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get active directory information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get active directory information" + ieisystem.inmanage.ad_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/adapter_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/adapter_info_module.rst new file mode 100644 index 000000000..16de82e45 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/adapter_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.adapter_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.adapter_info -- Get adapter information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.adapter_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get adapter information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Adapter test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get adapter information" + ieisystem.inmanage.adapter_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/add_ldisk_module.rst b/ansible_collections/ieisystem/inmanage/docs/add_ldisk_module.rst new file mode 100644 index 000000000..9a3eeca5f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/add_ldisk_module.rst @@ -0,0 +1,589 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.add_ldisk_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.add_ldisk -- Create logical disk ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.add_ldisk`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Create logical disk on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-accelerator"></div> + <b>accelerator</b> + <a class="ansibleOptionLink" href="#parameter-accelerator" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Driver accelerator, 1 - 1h, 2 - 2h, 3 - 3h.</div> + <div>Required when controller type is PMC.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-access"></div> + <b>access</b> + <a class="ansibleOptionLink" href="#parameter-access" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Access Policy, 1 - Read Write, 2 - Read Only, 3 - Blocked.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-cache"></div> + <b>cache</b> + <a class="ansibleOptionLink" href="#parameter-cache" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Drive Cache, 1 - Unchanged, 2 - Enabled, 3 - Disabled.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div> + <b>ctrl_id</b> + <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Raid controller ID.</div> + <div>Required when controller type is LSI, PMC or MV.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-init"></div> + <b>init</b> + <a class="ansibleOptionLink" href="#parameter-init" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Init State, 1 - No Init, 2 - Quick Init, 3 - Full Init.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-io"></div> + <b>io</b> + <a class="ansibleOptionLink" href="#parameter-io" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + </ul> + </td> + <td> + <div>IO Policy, 1 - Direct IO, 2 - Cached IO.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-level"></div> + <b>level</b> + <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>5</li> + <li>6</li> + <li>10</li> + </ul> + </td> + <td> + <div>RAID Level, 0 - RAID0, 1 - RAID1, 5 - RAID5, 6 - RAID6, 10 - RAID10.</div> + <div>Required when controller type is LSI or PMC.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-r"></div> + <b>r</b> + <a class="ansibleOptionLink" href="#parameter-r" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + </ul> + </td> + <td> + <div>Read Policy, 1 - Read Ahead, 2 - No Read Ahead.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-select"></div> + <b>select</b> + <a class="ansibleOptionLink" href="#parameter-select" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Select Size, from 1 to 100.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-size"></div> + <b>size</b> + <a class="ansibleOptionLink" href="#parameter-size" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + <li>5</li> + </ul> + </td> + <td> + <div>Strip Size, 0 - 32k, 1 - 64k, 2 - 128k, 3 - 256k, 4 - 512k, 5 - 1024k.</div> + <div>Required when controller type is LSI, PMC or MV.</div> + <div>When the controller type is MV, size is [0, 1].</div> + <div>When the controller type is LSI or PMC, size is [1, 2, 3, 4, 5].</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-slot"></div> + <b>slot</b> + <a class="ansibleOptionLink" href="#parameter-slot" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=integer</span> </div> + </td> + <td> + </td> + <td> + <div>Slot Num, input multiple slotNumber like 0, 1, 2....</div> + <div>Required when controller type is LSI or PMC.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-vname"></div> + <b>vname</b> + <a class="ansibleOptionLink" href="#parameter-vname" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Virtual drive name.</div> + <div>Required when controller type is PMC or server model is M7.</div> + <div>Required when controller type is MV.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-w"></div> + <b>w</b> + <a class="ansibleOptionLink" href="#parameter-w" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Write Policy, 1 - Write Through, 2 - Write Back, 3 - Write caching ok if bad BBU.</div> + <div>Required when controller type is LSI.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Add ldisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add LSI ldisk" + ieisystem.inmanage.add_ldisk: + ctrl_id: 0 + level: 1 + size: 1 + access: 1 + r: 1 + w: 1 + io: 1 + cache: 1 + init: 2 + select: 10 + slot: 0,1 + provider: "{{ inmanage }}" + + - name: "Add PMC ldisk" + ieisystem.inmanage.add_ldisk: + ctrl_id: 0 + level: 1 + size: 1 + accelerator: 1 + slot: 0,1 + vname: "test" + provider: "{{ inmanage }}" + + - name: "Add MV ldisk" + ieisystem.inmanage.add_ldisk: + ctrl_id: 0 + size: 1 + vname: "test" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/alert_policy_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/alert_policy_info_module.rst new file mode 100644 index 000000000..82936dfc2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/alert_policy_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.alert_policy_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.alert_policy_info -- Get alert policy +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.alert_policy_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get alert policy on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Alert test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get alert policy" + ieisystem.inmanage.alert_policy_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/audit_log_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/audit_log_info_module.rst new file mode 100644 index 000000000..05d7e0a8e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/audit_log_info_module.rst @@ -0,0 +1,358 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.audit_log_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.audit_log_info -- Get BMC audit log information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.audit_log_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BMC audit log information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-audit_file"></div> + <b>audit_file</b> + <a class="ansibleOptionLink" href="#parameter-audit_file" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Store logs to a file.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-count"></div> + <b>count</b> + <a class="ansibleOptionLink" href="#parameter-count" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Get the most recent log of a specified number.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-log_time"></div> + <b>log_time</b> + <a class="ansibleOptionLink" href="#parameter-log_time" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc audit log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc audit log information" + ieisystem.inmanage.audit_log_info: + log_time: "2020-06-01T12:30+08:00" + provider: "{{ inmanage }}" + + - name: "Get bmc audit log information" + ieisystem.inmanage.audit_log_info: + count: 30 + provider: "{{ inmanage }}" + + - name: "Get bmc audit log information" + ieisystem.inmanage.audit_log_info: + audit_file: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/auto_capture_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/auto_capture_info_module.rst new file mode 100644 index 000000000..9d375c6e2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/auto_capture_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.auto_capture_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.auto_capture_info -- Get auto capture screen information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.auto_capture_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get auto capture screen information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get auto capture screen information" + ieisystem.inmanage.auto_capture_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/backplane_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/backplane_info_module.rst new file mode 100644 index 000000000..67a9118d8 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/backplane_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.backplane_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.backplane_info -- Get disk backplane information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.backplane_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get disk backplane information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Disk backplane test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get backplane information" + ieisystem.inmanage.backplane_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/backup_module.rst b/ansible_collections/ieisystem/inmanage/docs/backup_module.rst new file mode 100644 index 000000000..1b972ba72 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/backup_module.rst @@ -0,0 +1,355 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.backup_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.backup -- Backup server settings ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.backup`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Backup server settings on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-bak_file"></div> + <b>bak_file</b> + <a class="ansibleOptionLink" href="#parameter-bak_file" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Backup file or bak folder.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-item"></div> + <b>item</b> + <a class="ansibleOptionLink" href="#parameter-item" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>all</li> + <li>network</li> + <li>service</li> + <li>ntp</li> + <li>snmptrap</li> + <li>dns</li> + <li>smtp</li> + <li>ad</li> + <li>ldap</li> + <li>user</li> + <li>bios</li> + <li>kvm</li> + <li>ipmi</li> + <li>authentication</li> + <li>syslog</li> + <li>ncsi</li> + </ul> + </td> + <td> + <div>Export item.</div> + <div>The values for M5 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', 'ldap', 'user', 'bios'.</div> + <div>The values for M6 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'kvm', 'ipmi', 'authentication', 'syslog'.</div> + <div>The values for M7 modules are 'all', 'network', 'service', 'syslog', 'ncsi'.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Backup test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Backup server settings" + ieisystem.inmanage.backup: + bak_file: "/home/wbs/" + item: "all" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/bios_export_module.rst b/ansible_collections/ieisystem/inmanage/docs/bios_export_module.rst new file mode 100644 index 000000000..70e269042 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/bios_export_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.bios_export_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.bios_export -- Export BIOS config +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.bios_export`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Export BIOS config on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Suffix is .json/.conf, FILEURI format, "/directory/filename".</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Export bios config" + ieisystem.inmanage.bios_export: + file_url: "/home/wbs/bios.conf" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/bios_import_module.rst b/ansible_collections/ieisystem/inmanage/docs/bios_import_module.rst new file mode 100644 index 000000000..8d77a7591 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/bios_import_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.bios_import_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.bios_import -- Import BIOS config +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.bios_import`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Import BIOS config on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Suffix is .json/.conf, FILEURI format, "/directory/filename".</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Import bios config" + ieisystem.inmanage.bios_import: + file_url: "/home/wbs/bios.conf" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/bios_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/bios_info_module.rst new file mode 100644 index 000000000..8ed8881f9 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/bios_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.bios_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.bios_info -- Get BIOS setup +++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.bios_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BIOS setup on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bios setup" + ieisystem.inmanage.bios_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/bmc_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/bmc_info_module.rst new file mode 100644 index 000000000..914714b86 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/bmc_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.bmc_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.bmc_info -- Get BMC information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.bmc_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BMC information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get BMC information" + ieisystem.inmanage.bmc_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/boot_image_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/boot_image_info_module.rst new file mode 100644 index 000000000..e2def2b0c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/boot_image_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.boot_image_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.boot_image_info -- Get bmc boot image information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.boot_image_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get bmc boot image information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot image test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc boot image information" + ieisystem.inmanage.boot_image_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/boot_option_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/boot_option_info_module.rst new file mode 100644 index 000000000..9359e782b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/boot_option_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.boot_option_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.boot_option_info -- Get BIOS boot options +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.boot_option_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BIOS boot options on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bios boot option" + ieisystem.inmanage.boot_option_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/clear_audit_log_module.rst b/ansible_collections/ieisystem/inmanage/docs/clear_audit_log_module.rst new file mode 100644 index 000000000..30cff724c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/clear_audit_log_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.clear_audit_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.clear_audit_log -- Clear BMC audit log ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.clear_audit_log`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Clear BMC audit log on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Clear BMC audit log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear BMC audit log " + ieisystem.inmanage.clear_audit_log: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/clear_event_log_module.rst b/ansible_collections/ieisystem/inmanage/docs/clear_event_log_module.rst new file mode 100644 index 000000000..252bee81c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/clear_event_log_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.clear_event_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.clear_event_log -- Clear event log ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.clear_event_log`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Clear event log on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Clear event log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear event log" + ieisystem.inmanage.clear_event_log: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/clear_system_log_module.rst b/ansible_collections/ieisystem/inmanage/docs/clear_system_log_module.rst new file mode 100644 index 000000000..46e6bebab --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/clear_system_log_module.rst @@ -0,0 +1,334 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.clear_system_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.clear_system_log -- Clear BMC system log ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.clear_system_log`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Clear BMC system log on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-level"></div> + <b>level</b> + <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>alert</b> ←</div></li> + <li>critical</li> + <li>error</li> + <li>notice</li> + <li>warning</li> + <li>debug</li> + <li>emergency</li> + <li>info</li> + <li>all</li> + </ul> + </td> + <td> + <div>Log level.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Clear BMC system log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear BMC system log" + ieisystem.inmanage.clear_system_log: + level: "alert" + provider: "{{ inmanage }}" + + - name: "Clear BMC system log" + ieisystem.inmanage.clear_system_log: + level: "all" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/collect_blackbox_module.rst b/ansible_collections/ieisystem/inmanage/docs/collect_blackbox_module.rst new file mode 100644 index 000000000..b7d89736a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/collect_blackbox_module.rst @@ -0,0 +1,319 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.collect_blackbox_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.collect_blackbox -- Collect blackbox log ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.collect_blackbox`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Collect blackbox log on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>File download path.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Collect blackbox test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Collect blackbox log" + ieisystem.inmanage.collect_blackbox: + file_url: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" + + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/collect_log_module.rst b/ansible_collections/ieisystem/inmanage/docs/collect_log_module.rst new file mode 100644 index 000000000..2e1243c33 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/collect_log_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.collect_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.collect_log -- Collect logs +++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.collect_log`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Collect logs on ieisystem Server, it takes about 5 minutes. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>File download path or path with filename, for example filepath/filename.tar.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Collect test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Collect logs" + ieisystem.inmanage.collect_log: + file_url: "/home/wbs/test.tar" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/connect_media_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/connect_media_info_module.rst new file mode 100644 index 000000000..edd668f54 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/connect_media_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.connect_media_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.connect_media_info -- Get remote images redirection information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.connect_media_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get remote images redirection information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Connect media test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get remote images redirection information" + ieisystem.inmanage.connect_media_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/cpu_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/cpu_info_module.rst new file mode 100644 index 000000000..88f73e1ee --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/cpu_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.cpu_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.cpu_info -- Get CPU information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.cpu_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get CPU information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: CPU test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get cpu information" + ieisystem.inmanage.cpu_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/del_session_module.rst b/ansible_collections/ieisystem/inmanage/docs/del_session_module.rst new file mode 100644 index 000000000..9171f4e40 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/del_session_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.del_session_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.del_session -- Delete session +++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.del_session`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Delete session on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-sid"></div> + <b>sid</b> + <a class="ansibleOptionLink" href="#parameter-sid" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Session Id, input "all" to delete all sessions.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Delete session test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Delete session" + ieisystem.inmanage.del_session: + sid: "223" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/dns_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/dns_info_module.rst new file mode 100644 index 000000000..228eb7586 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/dns_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.dns_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.dns_info -- Get dns information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.dns_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get dns information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: DNS test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get dns information" + ieisystem.inmanage.dns_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/download_auto_screenshot_module.rst b/ansible_collections/ieisystem/inmanage/docs/download_auto_screenshot_module.rst new file mode 100644 index 000000000..4bab4b073 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/download_auto_screenshot_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.download_auto_screenshot_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.download_auto_screenshot -- Download auto screenshots +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.download_auto_screenshot`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Download auto screenshots on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Screen capture file path.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Download auto screenshots" + ieisystem.inmanage.download_auto_screenshot: + file_url: "/home/wbs/screen" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/download_manual_screenshot_module.rst b/ansible_collections/ieisystem/inmanage/docs/download_manual_screenshot_module.rst new file mode 100644 index 000000000..e147eae6b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/download_manual_screenshot_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.download_manual_screenshot_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.download_manual_screenshot -- Download manual screenshots +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.download_manual_screenshot`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Download manual screenshots on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Screen capture file path.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Download manual screenshots" + ieisystem.inmanage.download_manual_screenshot: + file_url: "/home/wbs/screen" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ad_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ad_module.rst new file mode 100644 index 000000000..5ff1e742f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ad_module.rst @@ -0,0 +1,459 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ad_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ad -- Set active directory information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ad`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set active directory information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-addr1"></div> + <b>addr1</b> + <a class="ansibleOptionLink" href="#parameter-addr1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Domain Controller Server Address1. Enter the IP address of Active Directory server.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-addr2"></div> + <b>addr2</b> + <a class="ansibleOptionLink" href="#parameter-addr2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Domain Controller Server Address2. Enter the IP address of Active Directory server.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-addr3"></div> + <b>addr3</b> + <a class="ansibleOptionLink" href="#parameter-addr3" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Domain Controller Server Address3. Enter the IP address of Active Directory server.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-code"></div> + <b>code</b> + <a class="ansibleOptionLink" href="#parameter-code" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Secret Password. Specify the Password of the administrator.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-domain"></div> + <b>domain</b> + <a class="ansibleOptionLink" href="#parameter-domain" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>User Domain Name. Specify the Domain Name for the user for example MyDomain.com.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-enable"></div> + <b>enable</b> + <a class="ansibleOptionLink" href="#parameter-enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Active Directory Authentication Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-name"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Secret Username. Specify the Username of an administrator of the Active Directory Server.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ssl_enable"></div> + <b>ssl_enable</b> + <a class="ansibleOptionLink" href="#parameter-ssl_enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Active Directory SSL Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-timeout"></div> + <b>timeout</b> + <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>The Time Out configuration(15-300).</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set active directory information" + ieisystem.inmanage.edit_ad: + enable: "disable" + provider: "{{ inmanage }}" + + - name: "Set active directory information" + ieisystem.inmanage.edit_ad: + enable: "enable" + name: "test" + code: "123456" + timeout: 120 + domain: "test.com" + addr1: "100.2.2.2" + addr2: "100.2.2.3" + addr3: "100.2.2.4" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_alert_policy_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_alert_policy_module.rst new file mode 100644 index 000000000..35c858d1b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_alert_policy_module.rst @@ -0,0 +1,430 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_alert_policy_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_alert_policy -- Set alert policy +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_alert_policy`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set alert policy on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-channel"></div> + <b>channel</b> + <a class="ansibleOptionLink" href="#parameter-channel" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>shared</li> + <li>dedicated</li> + </ul> + </td> + <td> + <div>LAN Channel.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-destination"></div> + <b>destination</b> + <a class="ansibleOptionLink" href="#parameter-destination" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Alert destination. The address of the server receiving trap information sent by Trap.</div> + <div>When type is snmp, specify an IP address.</div> + <div>When type is email, specify a username.</div> + <div>When type is snmpdomain, specify a domain.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-id"></div> + <b>id</b> + <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Alert id. Customize the channel for sending alarms in Trap.</div> + <div>The values for M5 modules are 1, 2, 3.</div> + <div>The values for M6 modules are 1, 2, 3, 4.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Alert policy status. Whether to enable the receiving end for sending messages in trap mode.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-trap_port"></div> + <b>trap_port</b> + <a class="ansibleOptionLink" href="#parameter-trap_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>SNMP trap port(1-65535).</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-type"></div> + <b>type</b> + <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>snmp</li> + <li>email</li> + <li>snmpdomain</li> + </ul> + </td> + <td> + <div>Alert Type.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Alert policy test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set alert policy" + ieisystem.inmanage.edit_alert_policy: + id: 1 + status: "enable" + type: "snmp" + destination: "100.2.2.2" + channel: "shared" + provider: "{{ inmanage }}" + + - name: "Set alert policy" + ieisystem.inmanage.edit_alert_policy: + id: 1 + status: "disable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_auto_capture_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_auto_capture_module.rst new file mode 100644 index 000000000..f34e444c3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_auto_capture_module.rst @@ -0,0 +1,322 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_auto_capture_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_auto_capture -- Set auto capture screen ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_auto_capture`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set auto capture screen on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Capture status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set auto capture screen" + ieisystem.inmanage.edit_auto_capture: + status: "enable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_bios_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_bios_module.rst new file mode 100644 index 000000000..619bc496c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_bios_module.rst @@ -0,0 +1,377 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_bios_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_bios -- Set BIOS setup attributes ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_bios`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set BIOS setup attributes on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-attribute"></div> + <b>attribute</b> + <a class="ansibleOptionLink" href="#parameter-attribute" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>BIOS setup option.</div> + <div>Required when <em>list=False</em> and <em>file_url=None</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>BIOS option file. attribute must be used with value.</div> + <div>Mutually exclusive with fileurl format, "/directory/filename".</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-list"></div> + <b>list</b> + <a class="ansibleOptionLink" href="#parameter-list" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>no</b> ←</div></li> + <li>yes</li> + </ul> + </td> + <td> + <div>Show attribute name and configurable value.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-value"></div> + <b>value</b> + <a class="ansibleOptionLink" href="#parameter-value" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>BIOS setup option value.</div> + <div>Required when <em>list=False</em> and <em>file_url=None</em>.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bios setup" + ieisystem.inmanage.edit_bios: + attribute: "VMX" + value: "Disable" + provider: "{{ inmanage }}" + + - name: "Set bios setup" + ieisystem.inmanage.edit_bios: + attribute: "VMX" + value: "Enable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_boot_image_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_boot_image_module.rst new file mode 100644 index 000000000..7b054299b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_boot_image_module.rst @@ -0,0 +1,327 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_boot_image_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_boot_image -- Set bmc boot image +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_boot_image`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set bmc boot image on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-image"></div> + <b>image</b> + <a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + <li>5</li> + </ul> + </td> + <td> + <div>BMC boot image.</div> + <div>0-Higher firmware version; 1-Image 1; 2-Image 2; 3-Lower firmware version; 4-Latest updated firmware; 5-Not latest updated firmware.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot image test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bmc boot image" + ieisystem.inmanage.edit_boot_image: + image: 2 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_boot_option_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_boot_option_module.rst new file mode 100644 index 000000000..b8197774b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_boot_option_module.rst @@ -0,0 +1,365 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_boot_option_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_boot_option -- Set BIOS boot options +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_boot_option`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set BIOS boot options on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-device"></div> + <b>device</b> + <a class="ansibleOptionLink" href="#parameter-device" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>none</li> + <li>HDD</li> + <li>PXE</li> + <li>CD</li> + <li>BIOSSETUP</li> + </ul> + </td> + <td> + <div>Boot device.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-effective"></div> + <b>effective</b> + <a class="ansibleOptionLink" href="#parameter-effective" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Once</li> + <li>Continuous</li> + </ul> + </td> + <td> + <div>Effective, once or continuous.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mode"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Legacy</li> + <li>UEFI</li> + </ul> + </td> + <td> + <div>Boot type.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bios boot option" + ieisystem.inmanage.edit_boot_option: + device: "PXE" + effective: "Once" + mode: "Legacy" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_connect_media_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_connect_media_module.rst new file mode 100644 index 000000000..ff63a5fe8 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_connect_media_module.rst @@ -0,0 +1,360 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_connect_media_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_connect_media -- Start/Stop virtual media Image ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_connect_media`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Start/Stop virtual media Image on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-image_name"></div> + <b>image_name</b> + <a class="ansibleOptionLink" href="#parameter-image_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Image name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-image_type"></div> + <b>image_type</b> + <a class="ansibleOptionLink" href="#parameter-image_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>CD</li> + <li>FD</li> + <li>HD</li> + </ul> + </td> + <td> + <div>Virtual media type.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-op_type"></div> + <b>op_type</b> + <a class="ansibleOptionLink" href="#parameter-op_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>start</li> + <li>stop</li> + </ul> + </td> + <td> + <div>Start or stop media.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Connect media test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set remote image redirection" + ieisystem.inmanage.edit_connect_media: + image_type: "CD" + op_type: "start" + image_name: "aa.iso" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_dns_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_dns_module.rst new file mode 100644 index 000000000..6f5a028a1 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_dns_module.rst @@ -0,0 +1,620 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_dns_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_dns -- Set dns information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_dns`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set dns information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_iface"></div> + <b>dns_iface</b> + <a class="ansibleOptionLink" href="#parameter-dns_iface" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>DNS Interface, input like 'eth0', 'eth1', 'bond0'.</div> + <div>Required when <em>dns_manual=auto</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_manual"></div> + <b>dns_manual</b> + <a class="ansibleOptionLink" href="#parameter-dns_manual" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>manual</li> + <li>auto</li> + </ul> + </td> + <td> + <div>DNS Settings. Select whether the DNS interface will be configured manually or automatically.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_priority"></div> + <b>dns_priority</b> + <a class="ansibleOptionLink" href="#parameter-dns_priority" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>4</li> + <li>6</li> + </ul> + </td> + <td> + <div>IP Priority.</div> + <div>Required when <em>dns_manual=auto</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_server1"></div> + <b>dns_server1</b> + <a class="ansibleOptionLink" href="#parameter-dns_server1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>DNS Server1 IPv4 or IPv6 address.</div> + <div>Required when <em>dns_manual=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_server2"></div> + <b>dns_server2</b> + <a class="ansibleOptionLink" href="#parameter-dns_server2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>DNS Server2 IPv4 or IPv6 address.</div> + <div>Required when <em>dns_manual=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_server3"></div> + <b>dns_server3</b> + <a class="ansibleOptionLink" href="#parameter-dns_server3" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>DNS Server3 IPv4 or IPv6 address.</div> + <div>Required when <em>dns_manual=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dns_status"></div> + <b>dns_status</b> + <a class="ansibleOptionLink" href="#parameter-dns_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>DNS status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-domain_iface"></div> + <b>domain_iface</b> + <a class="ansibleOptionLink" href="#parameter-domain_iface" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Network Interface, input like 'eth0_v4', 'eth0_v6', 'eth1_v4', 'eth1_v6', 'bond0_v4', 'bond0_v6'.</div> + <div>Required when <em>domain_manual=auto</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-domain_manual"></div> + <b>domain_manual</b> + <a class="ansibleOptionLink" href="#parameter-domain_manual" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>manual</li> + <li>auto</li> + </ul> + </td> + <td> + <div>Domain Settings. Select whether the domain interface will be configured manually or automatically.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-domain_name"></div> + <b>domain_name</b> + <a class="ansibleOptionLink" href="#parameter-domain_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Domain Name.</div> + <div>Required when <em>domain_manual=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host_cfg"></div> + <b>host_cfg</b> + <a class="ansibleOptionLink" href="#parameter-host_cfg" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>manual</li> + <li>auto</li> + </ul> + </td> + <td> + <div>Host Settings. Select whether the host name will be configured manually or automatically.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host_name"></div> + <b>host_name</b> + <a class="ansibleOptionLink" href="#parameter-host_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Host Name.</div> + <div>Required when <em>host_cfg=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-register_status1"></div> + <b>register_status1</b> + <a class="ansibleOptionLink" href="#parameter-register_status1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>BMC register status 1.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-register_status2"></div> + <b>register_status2</b> + <a class="ansibleOptionLink" href="#parameter-register_status2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>BMC register status 2.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-registration_method1"></div> + <b>registration_method1</b> + <a class="ansibleOptionLink" href="#parameter-registration_method1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>nsupdate</li> + <li>dhcp</li> + <li>hostname</li> + </ul> + </td> + <td> + <div>Registration method 1.</div> + <div>Only the M6 model supports this parameter.</div> + <div>Required when <em>register_status1=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-registration_method2"></div> + <b>registration_method2</b> + <a class="ansibleOptionLink" href="#parameter-registration_method2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>nsupdate</li> + <li>dhcp</li> + <li>hostname</li> + </ul> + </td> + <td> + <div>Registration method 2.</div> + <div>Only the M6 model supports this parameter.</div> + <div>Required when <em>register_status2=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: DNS test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set dns information" + ieisystem.inmanage.edit_dns: + dns_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set dns information" + ieisystem.inmanage.edit_dns: + dns_status: "enable" + host_cfg: "manual" + host_name: "123456789" + domain_manual: "auto" + domain_iface: "eth0_v4" + dns_manual: "manual" + dns_server1: "100.2.2.2" + dns_server2: "100.2.2.3" + dns_server3: "100.2.2.4" + provider: "{{ inmanage }}" + + - name: "Set dns information" + ieisystem.inmanage.edit_dns: + dns_status: "enable" + host_cfg: "manual" + host_name: "123456789" + domain_manual: "manual" + domain_name: "test.com" + dns_manual: "auto" + dns_iface: "eth0" + dns_priority: "4" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_event_log_policy_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_event_log_policy_module.rst new file mode 100644 index 000000000..a7af95001 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_event_log_policy_module.rst @@ -0,0 +1,322 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_event_log_policy_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_event_log_policy -- Set event log policy +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_event_log_policy`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set event log policy on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-policy"></div> + <b>policy</b> + <a class="ansibleOptionLink" href="#parameter-policy" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Linear</li> + <li>Circular</li> + </ul> + </td> + <td> + <div>Event log policy.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Event log policy test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set event log policy" + ieisystem.inmanage.edit_event_log_policy: + policy: "Linear" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_fan_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_fan_module.rst new file mode 100644 index 000000000..c34eb6cf7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_fan_module.rst @@ -0,0 +1,359 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_fan_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_fan -- Set fan information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_fan`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set fan information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-fan_speed"></div> + <b>fan_speed</b> + <a class="ansibleOptionLink" href="#parameter-fan_speed" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Fan speed (duty ratio), range in 1 - 100.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-id"></div> + <b>id</b> + <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Fan id 255 is for all fans, 0~n.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mode"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Automatic</li> + <li>Manual</li> + </ul> + </td> + <td> + <div>Control mode, Manual or Automatic , Manual must be used with fans_peed.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fan test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set fan information" + ieisystem.inmanage.edit_fan: + mode: "Automatic" + provider: "{{ inmanage }}" + + - name: "Set fan information" + ieisystem.inmanage.edit_fan: + mode: "Manual" + id: 1 + fan_speed: 80 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_fru_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_fru_module.rst new file mode 100644 index 000000000..b3dfc9939 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_fru_module.rst @@ -0,0 +1,352 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_fru_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_fru -- Set fru settings ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_fru`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set fru settings on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-attribute"></div> + <b>attribute</b> + <a class="ansibleOptionLink" href="#parameter-attribute" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>CP</li> + <li>CS</li> + <li>PM</li> + <li>PPN</li> + <li>PS</li> + <li>PN</li> + <li>PV</li> + <li>PAT</li> + <li>BM</li> + <li>BPN</li> + <li>BS</li> + <li>BP</li> + </ul> + </td> + <td> + <div>CP is Chassis Part Number, CS is Chassis Serial, PM is Product Manufacturer.</div> + <div>PPN is Product Part Number, PS is Product Serial, PN is Product Name.</div> + <div>PV is Product Version, PAT is Product Asset Tag, BM is Board Mfg, BPN is Board Product Name.</div> + <div>BS is Board Serial, BP is Board Part Number.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-value"></div> + <b>value</b> + <a class="ansibleOptionLink" href="#parameter-value" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Set the value of attribute.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fru test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set Fru" + ieisystem.inmanage.edit_fru: + attribute: "CP" + value: "test" + provider: "{{ inmanage }}" + + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ipv4_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ipv4_module.rst new file mode 100644 index 000000000..4a5364b2f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ipv4_module.rst @@ -0,0 +1,427 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ipv4_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ipv4 -- Set ipv4 information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ipv4`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ipv4 information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface_name"></div> + <b>interface_name</b> + <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>eth0</li> + <li>eth1</li> + <li>bond0</li> + </ul> + </td> + <td> + <div>Set interface name. Select the LAN interface to be configured.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv4_address"></div> + <b>ipv4_address</b> + <a class="ansibleOptionLink" href="#parameter-ipv4_address" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface.</div> + <div>Required when <em>ipv4_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv4_dhcp_enable"></div> + <b>ipv4_dhcp_enable</b> + <a class="ansibleOptionLink" href="#parameter-ipv4_dhcp_enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>dhcp</li> + <li>static</li> + </ul> + </td> + <td> + <div>Enable 'Enable DHCP' to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv4_gateway"></div> + <b>ipv4_gateway</b> + <a class="ansibleOptionLink" href="#parameter-ipv4_gateway" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.</div> + <div>Required when <em>ipv4_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv4_status"></div> + <b>ipv4_status</b> + <a class="ansibleOptionLink" href="#parameter-ipv4_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable or disable IPV4.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv4_subnet"></div> + <b>ipv4_subnet</b> + <a class="ansibleOptionLink" href="#parameter-ipv4_subnet" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface.</div> + <div>Required when <em>ipv4_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ipv4 test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ipv4 information" + ieisystem.inmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set ipv4 information" + ieisystem.inmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "enable" + ipv4_dhcp_enable: "dhcp" + provider: "{{ inmanage }}" + + - name: "Set ipv4 information" + ieisystem.inmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "enable" + ipv4_dhcp_enable: "static" + ipv4_address: "100.2.36.10" + ipv4_subnet: "255.255.255.0" + ipv4_gateway: "100.2.36.1" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ipv6_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ipv6_module.rst new file mode 100644 index 000000000..edb0082f1 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ipv6_module.rst @@ -0,0 +1,444 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ipv6_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ipv6 -- Set ipv6 information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ipv6`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ipv6 information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface_name"></div> + <b>interface_name</b> + <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>eth0</li> + <li>eth1</li> + <li>bond0</li> + </ul> + </td> + <td> + <div>Set interface name. Select the LAN interface to be configured.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv6_address"></div> + <b>ipv6_address</b> + <a class="ansibleOptionLink" href="#parameter-ipv6_address" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>If DHCP is disabled, specify a static IPv6 address to be configured for the selected interface.</div> + <div>Required when <em>ipv6_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv6_dhcp_enable"></div> + <b>ipv6_dhcp_enable</b> + <a class="ansibleOptionLink" href="#parameter-ipv6_dhcp_enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>dhcp</li> + <li>static</li> + </ul> + </td> + <td> + <div>Enable 'Enable DHCP' to dynamically configure IPv6 address using Dynamic Host Configuration Protocol (DHCP).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv6_gateway"></div> + <b>ipv6_gateway</b> + <a class="ansibleOptionLink" href="#parameter-ipv6_gateway" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.</div> + <div>Required when <em>ipv6_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv6_index"></div> + <b>ipv6_index</b> + <a class="ansibleOptionLink" href="#parameter-ipv6_index" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Ipv6 index(0-15).</div> + <div>Required when <em>ipv6_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv6_prefix"></div> + <b>ipv6_prefix</b> + <a class="ansibleOptionLink" href="#parameter-ipv6_prefix" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>The subnet prefix length for the IPv6 settings(0-128).</div> + <div>Required when <em>ipv6_dhcp_enable=static</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ipv6_status"></div> + <b>ipv6_status</b> + <a class="ansibleOptionLink" href="#parameter-ipv6_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable or disable IPV6.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ipv6 test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ipv6 information" + ieisystem.inmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set ipv6 information" + ieisystem.inmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "enable" + ipv6_dhcp_enable: "dhcp" + provider: "{{ inmanage }}" + + - name: "Set ipv6 information" + ieisystem.inmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "enable" + ipv6_dhcp_enable: "static" + ipv6_address: "::ffff:100:2:36:10" + ipv6_index: 12 + ipv6_prefix: 16 + ipv6_gateway: "::" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_kvm_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_kvm_module.rst new file mode 100644 index 000000000..b97d3094e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_kvm_module.rst @@ -0,0 +1,543 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_kvm_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_kvm -- Set KVM +++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_kvm`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set KVM on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-automatic_off"></div> + <b>automatic_off</b> + <a class="ansibleOptionLink" href="#parameter-automatic_off" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Automatically OFF Server Monitor, When KVM Launches.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-client_type"></div> + <b>client_type</b> + <a class="ansibleOptionLink" href="#parameter-client_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>vnc</li> + <li>viewer</li> + </ul> + </td> + <td> + <div>Client Type.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-keyboard_language"></div> + <b>keyboard_language</b> + <a class="ansibleOptionLink" href="#parameter-keyboard_language" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>AD</li> + <li>DA</li> + <li>NL-BE</li> + <li>NL-NL</li> + <li>GB</li> + <li>US</li> + <li>FI</li> + <li>FR-BE</li> + <li>FR</li> + <li>DE</li> + <li>DE-CH</li> + <li>IT</li> + <li>JP</li> + <li>ON</li> + <li>PT</li> + <li>EC</li> + <li>SV</li> + <li>TR_F</li> + <li>TR_Q</li> + </ul> + </td> + <td> + <div>Select the Keyboard Language.</div> + <div>AD is Auto Detect, DA is Danish, NL-BE is Dutch Belgium, NL-NL is Dutch Netherland.</div> + <div>GB is English UK , US is English US, FI is Finnish, FR-BE is French Belgium, FR is French France.</div> + <div>DE is German Germany, DE-CH is German Switzerland, IT is Italian, JP is Japanese.</div> + <div>NO is Norwegian, PT is Portuguese, ES is Spanish, SV is Swedish, TR_F is Turkish F, TR_Q is Turkish Q.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm_encryption"></div> + <b>kvm_encryption</b> + <a class="ansibleOptionLink" href="#parameter-kvm_encryption" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Encrypt KVM packets.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-local_monitor_off"></div> + <b>local_monitor_off</b> + <a class="ansibleOptionLink" href="#parameter-local_monitor_off" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Server Monitor OFF Feature Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-media_attach"></div> + <b>media_attach</b> + <a class="ansibleOptionLink" href="#parameter-media_attach" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>attach</li> + <li>auto</li> + </ul> + </td> + <td> + <div>Two types of VM attach mode are available.</div> + <div>Attach is Immediately attaches Virtual Media to the server upon bootup.</div> + <div>Auto is Attaches Virtual Media to the server only when a virtual media session is started.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-non_secure"></div> + <b>non_secure</b> + <a class="ansibleOptionLink" href="#parameter-non_secure" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable/disable Non Secure Connection Type.</div> + <div>Only the M6 model supports this parameter.</div> + <div>Required when <em>client_type=vnc</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-retry_count"></div> + <b>retry_count</b> + <a class="ansibleOptionLink" href="#parameter-retry_count" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-retry_time_interval"></div> + <b>retry_time_interval</b> + <a class="ansibleOptionLink" href="#parameter-retry_time_interval" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>The Identification for retry time interval configuration (5-30) seconds.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ssh_vnc"></div> + <b>ssh_vnc</b> + <a class="ansibleOptionLink" href="#parameter-ssh_vnc" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable/disable VNC over SSH in BMC.</div> + <div>Only the M6 model supports this parameter.</div> + <div>Required when <em>client_type=vnc</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-stunnel_vnc"></div> + <b>stunnel_vnc</b> + <a class="ansibleOptionLink" href="#parameter-stunnel_vnc" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable/disable VNC over Stunnel in BMC.</div> + <div>Only the M6 model supports this parameter.</div> + <div>Required when <em>client_type=vnc</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: KVM test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set KVM" + ieisystem.inmanage.edit_kvm: + kvm_encryption: "enable" + media_attach: "auto" + keyboard_language: "AD" + retry_count: 13 + retry_time_interval: 10 + local_monitor_off: "enable" + automatic_off: "enable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ldap_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ldap_module.rst new file mode 100644 index 000000000..32a4d8ccf --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ldap_module.rst @@ -0,0 +1,526 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ldap_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ldap -- Set ldap information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ldap`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ldap information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-address"></div> + <b>address</b> + <a class="ansibleOptionLink" href="#parameter-address" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Server Address.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-attr"></div> + <b>attr</b> + <a class="ansibleOptionLink" href="#parameter-attr" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>cn</li> + <li>uid</li> + </ul> + </td> + <td> + <div>Attribute of User Login.</div> + <div>The Attribute of User Login field indicates to the LDAP/E-Directory server which attribute should be used to identify the user.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-base"></div> + <b>base</b> + <a class="ansibleOptionLink" href="#parameter-base" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Search Base.</div> + <div>The Search Base allows the LDAP/E-Directory server to find which part of the external directory tree is to be searched.</div> + <div>This search base may be equivalent to the organization or the group of the external directory.</div> + <div>Search base is a string of 4 to 64 alphanumeric characters.</div> + <div>It must start with an alphabetical character.</div> + <div>Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are allowed.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ca"></div> + <b>ca</b> + <a class="ansibleOptionLink" href="#parameter-ca" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>CA certificate file path.</div> + <div>Required when <em>encry=StartTLS</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ce"></div> + <b>ce</b> + <a class="ansibleOptionLink" href="#parameter-ce" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Certificate file path.</div> + <div>Required when <em>encry=StartTLS</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-cn"></div> + <b>cn</b> + <a class="ansibleOptionLink" href="#parameter-cn" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>ip</li> + <li>fqdn</li> + </ul> + </td> + <td> + <div>Common name type.</div> + <div>Required when <em>encry=StartTLS</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-code"></div> + <b>code</b> + <a class="ansibleOptionLink" href="#parameter-code" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Password. The Bind password is also used in the bind authentication operations between client and server.</div> + <div>Required when <em>enable=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dn"></div> + <b>dn</b> + <a class="ansibleOptionLink" href="#parameter-dn" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Bind DN. The Bind DN is used in bind operations, which authenticates the client to the server.</div> + <div>Bind DN is a string of 4 to 64 alphanumeric characters.</div> + <div>It must start with an alphabetical character.</div> + <div>Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are allowed.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-enable"></div> + <b>enable</b> + <a class="ansibleOptionLink" href="#parameter-enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>LDAP/E-Directory Authentication Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-encry"></div> + <b>encry</b> + <a class="ansibleOptionLink" href="#parameter-encry" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>SSL</li> + <li>StartTLS</li> + </ul> + </td> + <td> + <div>Encryption Type.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-pk"></div> + <b>pk</b> + <a class="ansibleOptionLink" href="#parameter-pk" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Private Key file path.</div> + <div>Required when <em>encry=StartTLS</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_port"></div> + <b>server_port</b> + <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Server Port. Specify the LDAP/E-Directory Port.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ldap information" + ieisystem.inmanage.edit_ldap: + enable: "disable" + provider: "{{ inmanage }}" + + - name: "Set ldap information" + ieisystem.inmanage.edit_ldap: + enable: "enable" + encry: "SSL" + address: "100.2.2.2" + server_port: 389 + dn: "cn=manager,ou=login,dc=domain,dc=com" + code: "123456" + base: "cn=manager" + attr: "uid" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ldisk_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ldisk_module.rst new file mode 100644 index 000000000..ec1a48078 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ldisk_module.rst @@ -0,0 +1,378 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ldisk_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ldisk -- Set logical disk ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ldisk`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set logical disk on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div> + <b>ctrl_id</b> + <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Raid controller ID.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-duration"></div> + <b>duration</b> + <a class="ansibleOptionLink" href="#parameter-duration" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Duration range is 1-255, physical drive under PMC raid controller.</div> + <div>Required when <em>option=LOC</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ldisk_id"></div> + <b>ldisk_id</b> + <a class="ansibleOptionLink" href="#parameter-ldisk_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Logical disk ID.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-option"></div> + <b>option</b> + <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>LOC</li> + <li>STL</li> + <li>FI</li> + <li>SFI</li> + <li>SI</li> + <li>DEL</li> + </ul> + </td> + <td> + <div>Set operation options for a logical disk.</div> + <div>LOC is Locate Logical Drive, STL is Stop Locate LogicalDrive.</div> + <div>FI is Fast Initialization, SFI is Slow/Full Initialization.</div> + <div>SI is Stop Initialization, DEL is Delete LogicalDrive.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit ldisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit ldisk" + ieisystem.inmanage.edit_ldisk: + ctrl_id: 0 + ldisk_id: 1 + option: "LOC" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_log_setting_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_log_setting_module.rst new file mode 100644 index 000000000..9184d28fa --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_log_setting_module.rst @@ -0,0 +1,474 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_log_setting_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_log_setting -- Set bmc system and audit log setting ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_log_setting`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set bmc system and audit log setting on ieisystem Server. +- Only the M5 models support this feature. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-audit_status"></div> + <b>audit_status</b> + <a class="ansibleOptionLink" href="#parameter-audit_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Audit Log Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-audit_type"></div> + <b>audit_type</b> + <a class="ansibleOptionLink" href="#parameter-audit_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>local</li> + <li>remote</li> + <li>both</li> + </ul> + </td> + <td> + <div>Audit log type.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_size"></div> + <b>file_size</b> + <a class="ansibleOptionLink" href="#parameter-file_size" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>File Size(3-65535bytes), set when type is local(default 30000).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-protocol_type"></div> + <b>protocol_type</b> + <a class="ansibleOptionLink" href="#parameter-protocol_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>UDP</li> + <li>TCP</li> + </ul> + </td> + <td> + <div>Protocol Type, set when type is remote.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-rotate_count"></div> + <b>rotate_count</b> + <a class="ansibleOptionLink" href="#parameter-rotate_count" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + </ul> + </td> + <td> + <div>Rotate Count, set when type is local, 0-delete old files(default), 1-bak old files.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_addr"></div> + <b>server_addr</b> + <a class="ansibleOptionLink" href="#parameter-server_addr" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Server Address, set when type is remote.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_port"></div> + <b>server_port</b> + <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Server Port(0-65535), set when type is remote.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>System Log Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-type"></div> + <b>type</b> + <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>local</li> + <li>remote</li> + <li>both</li> + </ul> + </td> + <td> + <div>System log type.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit log setting test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit bmc system log setting" + ieisystem.inmanage.edit_log_setting: + status: "enable" + type: "both" + provider: "{{ inmanage }}" + + - name: "Edit bmc audit log setting" + ieisystem.inmanage.edit_log_setting: + audit_status: "enable" + audit_type: "remote" + server_addr: "100.2.126.11" + server_port: "514" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_m6_log_setting_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_m6_log_setting_module.rst new file mode 100644 index 000000000..e1bcf1e05 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_m6_log_setting_module.rst @@ -0,0 +1,490 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_m6_log_setting_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_m6_log_setting -- Set bmc system and audit log setting +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_m6_log_setting`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set bmc system and audit log setting on ieisystem Server. +- Only the M6 models support this feature. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host_tag"></div> + <b>host_tag</b> + <a class="ansibleOptionLink" href="#parameter-host_tag" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>HostName</li> + <li>SerialNum</li> + <li>AssertTag</li> + </ul> + </td> + <td> + <div>System log host tag, set when <em>status=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-level"></div> + <b>level</b> + <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Critical</li> + <li>Warning</li> + <li>Info</li> + </ul> + </td> + <td> + <div>Events Level, set when <em>status=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-log_type"></div> + <b>log_type</b> + <a class="ansibleOptionLink" href="#parameter-log_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>idl</li> + <li>audit</li> + <li>both</li> + </ul> + </td> + <td> + <div>Remote Log Type, set when server_id is not none.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-protocol_type"></div> + <b>protocol_type</b> + <a class="ansibleOptionLink" href="#parameter-protocol_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>UDP</li> + <li>TCP</li> + </ul> + </td> + <td> + <div>Protocol Type, set when <em>status=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_addr"></div> + <b>server_addr</b> + <a class="ansibleOptionLink" href="#parameter-server_addr" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Server Address, set when server_id is not none.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_id"></div> + <b>server_id</b> + <a class="ansibleOptionLink" href="#parameter-server_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Syslog Server ID, set when <em>status=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_port"></div> + <b>server_port</b> + <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Server Address, set when server_id is not none.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>System Log Status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-test"></div> + <b>test</b> + <a class="ansibleOptionLink" href="#parameter-test" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>no</b> ←</div></li> + <li>yes</li> + </ul> + </td> + <td> + <div>Test remote log settings, set when server_id is not none.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit log setting test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit bmc system log setting" + ieisystem.inmanage.edit_m6_log_setting: + status: "disable" + provider: "{{ inmanage }}" + + - name: "Edit bmc audit log setting" + ieisystem.inmanage.edit_m6_log_setting: + status: "enable" + host_tag: "HostName" + level: "Info" + protocol_type: "TCP" + server_id: 0 + server_addr: "100.2.126.11" + server_port: 514 + log_type: "both" + provider: "{{ inmanage }}" + + - name: "test bmc audit log" + ieisystem.inmanage.edit_m6_log_setting: + server_id: 0 + test: True + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_manual_capture_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_manual_capture_module.rst new file mode 100644 index 000000000..72f9e2bc1 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_manual_capture_module.rst @@ -0,0 +1,322 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_manual_capture_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_manual_capture -- Set manual capture screen ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_manual_capture`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set manual capture screen on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-type"></div> + <b>type</b> + <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>capture</li> + <li>delete</li> + </ul> + </td> + <td> + <div>Manual type.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set manual capture screen" + ieisystem.inmanage.edit_manual_capture: + type: "capture" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_media_instance_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_media_instance_module.rst new file mode 100644 index 000000000..36a853fd3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_media_instance_module.rst @@ -0,0 +1,502 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_media_instance_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_media_instance -- Set Virtual Media Instance +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_media_instance`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set Virtual Media Instance on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm_num_cd"></div> + <b>kvm_num_cd</b> + <a class="ansibleOptionLink" href="#parameter-kvm_num_cd" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Select the number of Remote KVM CD/DVD devices that support for virtual Media redirection.</div> + <div>The max support number of html5 KVM is 2 and java KVM is 4.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm_num_fd"></div> + <b>kvm_num_fd</b> + <a class="ansibleOptionLink" href="#parameter-kvm_num_fd" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Select the number of Remote KVM floppy devices that support for Virtual Media redirection.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm_num_hd"></div> + <b>kvm_num_hd</b> + <a class="ansibleOptionLink" href="#parameter-kvm_num_hd" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-num_cd"></div> + <b>num_cd</b> + <a class="ansibleOptionLink" href="#parameter-num_cd" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Select the number of CD/DVD devices that support for Virtual Media redirection.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-num_fd"></div> + <b>num_fd</b> + <a class="ansibleOptionLink" href="#parameter-num_fd" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Select the number of floppy devices that support for Virtual Media redirection.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-num_hd"></div> + <b>num_hd</b> + <a class="ansibleOptionLink" href="#parameter-num_hd" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Select the number of harddisk devices that support for Virtual Media redirection.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-power_save_mode"></div> + <b>power_save_mode</b> + <a class="ansibleOptionLink" href="#parameter-power_save_mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Enable</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>Check this option to enable Power Save Mode in BMC.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-sd_media"></div> + <b>sd_media</b> + <a class="ansibleOptionLink" href="#parameter-sd_media" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Enable</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>Check this option to enable SD Media support in BMC.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secure_channel"></div> + <b>secure_channel</b> + <a class="ansibleOptionLink" href="#parameter-secure_channel" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Enable</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>Check this option to enable encrypt media recirection packets.</div> + <div>Only the M5/M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media instance test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set media instance" + ieisystem.inmanage.edit_media_instance: + num_fd: 1 + num_cd: 1 + num_hd: 1 + kvm_num_fd: 1 + kvm_num_cd: 1 + kvm_num_hd: 1 + sd_media: "Enable" + secure_channel: "Enable" + power_save_mode: "Enable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ncsi_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ncsi_module.rst new file mode 100644 index 000000000..b8fa63079 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ncsi_module.rst @@ -0,0 +1,389 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ncsi_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ncsi -- Set ncsi information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ncsi`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ncsi information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-channel_number"></div> + <b>channel_number</b> + <a class="ansibleOptionLink" href="#parameter-channel_number" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Channel number.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface_name"></div> + <b>interface_name</b> + <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Interface name, for example eth0.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mode"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>auto</li> + <li>manual</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>NCSI mode, auto-Auto Failover, manual-Manual Switch.</div> + <div>Only M6 model supports <code>Disable</code> Settings.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-nic_type"></div> + <b>nic_type</b> + <a class="ansibleOptionLink" href="#parameter-nic_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>PHY</li> + <li>OCP</li> + <li>OCP1</li> + <li>PCIE</li> + <li>auto</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>Nic type.</div> + <div>Only NF3280A6 and NF3180A6 model supports <code>Disable</code> Settings, but not support <code>PHY</code> Settings.</div> + <div>M6 model only support <code>OCP</code>, <code>OCP1</code>, <code>PCIE</code> settings.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NCSI test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ncsi information" + ieisystem.inmanage.edit_ncsi: + mode: "manual" + nic_type: "PCIE" + interface_name: "eth0" + channel_number: 1 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_network_bond_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_network_bond_module.rst new file mode 100644 index 000000000..0da1d87f5 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_network_bond_module.rst @@ -0,0 +1,363 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_network_bond_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_network_bond -- Set network bond +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_network_bond`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set network bond on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auto_config"></div> + <b>auto_config</b> + <a class="ansibleOptionLink" href="#parameter-auto_config" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable this option to configure the interfaces in service configuration automatically.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-bond"></div> + <b>bond</b> + <a class="ansibleOptionLink" href="#parameter-bond" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Network bond status, If VLAN is enabled for slave interfaces, then Bonding cannot be enabled.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface"></div> + <b>interface</b> + <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>shared</li> + <li>dedicated</li> + <li>both</li> + </ul> + </td> + <td> + <div>Interface name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bond test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network bond" + ieisystem.inmanage.edit_network_bond: + bond: "enable" + interface: "dedicated" + auto_config: "enable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_network_link_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_network_link_module.rst new file mode 100644 index 000000000..f07d16bc2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_network_link_module.rst @@ -0,0 +1,392 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_network_link_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_network_link -- Set network link +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_network_link`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set network link on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auto_nego"></div> + <b>auto_nego</b> + <a class="ansibleOptionLink" href="#parameter-auto_nego" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>This option allows the device to perform auto-configuration.</div> + <div>To achieve the best mode of operation (speed and duplex) on the link.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-duplex_mode"></div> + <b>duplex_mode</b> + <a class="ansibleOptionLink" href="#parameter-duplex_mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>HALF</li> + <li>FULL</li> + </ul> + </td> + <td> + <div>Select any one of the following Duplex Mode.</div> + <div>Required when <em>auto_nego=disable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface"></div> + <b>interface</b> + <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>shared</li> + <li>dedicated</li> + <li>both</li> + </ul> + </td> + <td> + <div>Interface name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-link_speed"></div> + <b>link_speed</b> + <a class="ansibleOptionLink" href="#parameter-link_speed" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>10</li> + <li>100</li> + </ul> + </td> + <td> + <div>Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps.</div> + <div>Required when <em>auto_nego=disable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Link test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network link" + ieisystem.inmanage.edit_network_link: + interface: "dedicated" + auto_nego: "enable" + provider: "{{ inmanage }}" + + - name: "Set network link" + ieisystem.inmanage.edit_network_link: + interface: "dedicated" + auto_nego: "disable" + link_speed: 100 + duplex_mode: "FULL" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_network_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_network_module.rst new file mode 100644 index 000000000..dfc07c571 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_network_module.rst @@ -0,0 +1,343 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_network_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_network -- Set network information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_network`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set netowrk information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface_name"></div> + <b>interface_name</b> + <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>eth0</li> + <li>eth1</li> + <li>bond0</li> + </ul> + </td> + <td> + <div>Set interface name. Select the LAN interface to be configured.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-lan_enable"></div> + <b>lan_enable</b> + <a class="ansibleOptionLink" href="#parameter-lan_enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable or disable this interface. If disable, you cannot use this interface any more.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Network test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network information" + ieisystem.inmanage.edit_network: + interface_name: "eth0" + lan_enable: "enable" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_ntp_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_ntp_module.rst new file mode 100644 index 000000000..3dda355a3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_ntp_module.rst @@ -0,0 +1,486 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_ntp_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_ntp -- Set NTP +++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_ntp`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set NTP on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auto_date"></div> + <b>auto_date</b> + <a class="ansibleOptionLink" href="#parameter-auto_date" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Date auto synchronize.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-max_variety"></div> + <b>max_variety</b> + <a class="ansibleOptionLink" href="#parameter-max_variety" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Maximum jump time(minute), max variety(1-60).</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ntp_time"></div> + <b>ntp_time</b> + <a class="ansibleOptionLink" href="#parameter-ntp_time" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP time(YYYYmmddHHMMSS).</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server1"></div> + <b>server1</b> + <a class="ansibleOptionLink" href="#parameter-server1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Server1(ipv4 or ipv6 or domain name), set when auto_date is enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server2"></div> + <b>server2</b> + <a class="ansibleOptionLink" href="#parameter-server2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Server2(ipv4 or ipv6 or domain name), set when auto_date is enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server3"></div> + <b>server3</b> + <a class="ansibleOptionLink" href="#parameter-server3" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Server3(ipv4 or ipv6 or domain name), set when auto_date is enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server4"></div> + <b>server4</b> + <a class="ansibleOptionLink" href="#parameter-server4" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Server4(ipv4 or ipv6 or domain name), set when auto_date is enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server5"></div> + <b>server5</b> + <a class="ansibleOptionLink" href="#parameter-server5" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Server5(ipv4 or ipv6 or domain name), set when auto_date is enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server6"></div> + <b>server6</b> + <a class="ansibleOptionLink" href="#parameter-server6" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP Server6(ipv4 or ipv6 or domain name), set when auto_date is enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-syn_cycle"></div> + <b>syn_cycle</b> + <a class="ansibleOptionLink" href="#parameter-syn_cycle" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>NTP syn cycle(minute), sync cycle(5-1440).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-time_zone"></div> + <b>time_zone</b> + <a class="ansibleOptionLink" href="#parameter-time_zone" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>UTC time zone, chose from {-12, -11.5, -11, ... , 11, 11.5, 12}.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NTP test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ntp" + ieisystem.inmanage.edit_ntp: + auto_date: "enable" + server2: "time.nist.gov" + provider: "{{ inmanage }}" + + - name: "Set ntp" + ieisystem.inmanage.edit_ntp: + auto_date: "disable" + ntp_time: "20200609083600" + provider: "{{ inmanage }}" + + - name: "set ntp" + ieisystem.inmanage.edit_ntp: + time_zone: "8" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_pdisk_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_pdisk_module.rst new file mode 100644 index 000000000..f06d13f30 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_pdisk_module.rst @@ -0,0 +1,482 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_pdisk_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_pdisk -- Set physical disk +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_pdisk`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set physical disk on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-action"></div> + <b>action</b> + <a class="ansibleOptionLink" href="#parameter-action" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>remove</li> + <li>global</li> + <li>dedicate</li> + </ul> + </td> + <td> + <div>Action while set physical drive hotspare.</div> + <div>Required when <em>option=HS</em>.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div> + <b>ctrl_id</b> + <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Raid controller ID.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-device_id"></div> + <b>device_id</b> + <a class="ansibleOptionLink" href="#parameter-device_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Physical drive id.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-duration"></div> + <b>duration</b> + <a class="ansibleOptionLink" href="#parameter-duration" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Duration range is 1-255, physical drive under PMC raid controller.</div> + <div>Required when <em>option=LOC</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-encl"></div> + <b>encl</b> + <a class="ansibleOptionLink" href="#parameter-encl" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>yes</li> + <li>no</li> + </ul> + </td> + <td> + <div>IsEnclAffinity while set physical drive hotspare.</div> + <div>Required when <em>option=HS</em> and <em>action=dedicate</em>.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-logical_drivers"></div> + <b>logical_drivers</b> + <a class="ansibleOptionLink" href="#parameter-logical_drivers" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=integer</span> </div> + </td> + <td> + </td> + <td> + <div>Logical Drivers while set physical drive hotspare, input multiple Logical Drivers index like 0, 1, 2.....</div> + <div>Required when <em>option=HS</em> and <em>action=dedicate</em>.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-option"></div> + <b>option</b> + <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>UG</li> + <li>UB</li> + <li>OFF</li> + <li>FAIL</li> + <li>RBD</li> + <li>ON</li> + <li>JB</li> + <li>ES</li> + <li>EM</li> + <li>EN</li> + <li>ET</li> + <li>LOC</li> + <li>STL</li> + <li>HS</li> + </ul> + </td> + <td> + <div>Set operation options for a physical disk.</div> + <div>UG is Unconfigured Good, UB is Unconfigured Bad.</div> + <div>OFF is offline, FAIL is Failed, RBD is Rebuild.</div> + <div>ON is Online, JB is JBOD, ES is Drive Erase stop.</div> + <div>EM is Drive Erase Simple, EN is Drive Erase Normal.</div> + <div>ET is Drive Erase Through, LOC is Locate, STL is Stop Locate.</div> + <div>HS is Hot spare.</div> + <div>Only the M5 model supports <code>HS</code> Settings.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-revertible"></div> + <b>revertible</b> + <a class="ansibleOptionLink" href="#parameter-revertible" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>yes</li> + <li>no</li> + </ul> + </td> + <td> + <div>IsRevertible while set physical drive hotspare.</div> + <div>Required when <em>option=HS</em> and <em>action=dedicate</em>.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit pdisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit pdisk" + ieisystem.inmanage.edit_pdisk: + ctrl_id: 0 + device_id: 1 + option: "LOC" + provider: "{{ inmanage }}" + + - name: "M5 Edit pdisk" + ieisystem.inmanage.edit_pdisk: + ctrl_id: 0 + device_id: 1 + option: "HS" + action: "dedicate" + revertible: "yes" + encl: "yes" + logical_drivers: 1 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_power_budget_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_power_budget_module.rst new file mode 100644 index 000000000..c47d6ca36 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_power_budget_module.rst @@ -0,0 +1,685 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_power_budget_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_power_budget -- Set power budget information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_power_budget`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set power budget information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-action"></div> + <b>action</b> + <a class="ansibleOptionLink" href="#parameter-action" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>add</li> + <li>delete</li> + <li>open</li> + <li>close</li> + </ul> + </td> + <td> + <div>Type to action.</div> + <div>Required when <em>range=False</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-domain"></div> + <b>domain</b> + <a class="ansibleOptionLink" href="#parameter-domain" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>system</li> + <li>cpu</li> + </ul> + </td> + <td> + <div>Domain id.</div> + <div>Required when <em>range=False</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-end1"></div> + <b>end1</b> + <a class="ansibleOptionLink" href="#parameter-end1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-end2"></div> + <b>end2</b> + <a class="ansibleOptionLink" href="#parameter-end2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-end3"></div> + <b>end3</b> + <a class="ansibleOptionLink" href="#parameter-end3" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-end4"></div> + <b>end4</b> + <a class="ansibleOptionLink" href="#parameter-end4" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-end5"></div> + <b>end5</b> + <a class="ansibleOptionLink" href="#parameter-end5" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-except_action"></div> + <b>except_action</b> + <a class="ansibleOptionLink" href="#parameter-except_action" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>Except action, 0 is do nothing, 1 is send alert, 2 is shutdown system, 3 is shutdown system and send alert.</div> + <div>Only the M7 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-id"></div> + <b>id</b> + <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Policy id.</div> + <div>Required when <em>range=False</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-range"></div> + <b>range</b> + <a class="ansibleOptionLink" href="#parameter-range" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>no</b> ←</div></li> + <li>yes</li> + </ul> + </td> + <td> + <div>Range of power budget watts.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-start1"></div> + <b>start1</b> + <a class="ansibleOptionLink" href="#parameter-start1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-start2"></div> + <b>start2</b> + <a class="ansibleOptionLink" href="#parameter-start2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-start3"></div> + <b>start3</b> + <a class="ansibleOptionLink" href="#parameter-start3" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-start4"></div> + <b>start4</b> + <a class="ansibleOptionLink" href="#parameter-start4" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-start5"></div> + <b>start5</b> + <a class="ansibleOptionLink" href="#parameter-start5" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Period of add, start time, from 0 to 24.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-watts"></div> + <b>watts</b> + <a class="ansibleOptionLink" href="#parameter-watts" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Power budget watts of add.</div> + <div>Required when <em>action=add</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-week1"></div> + <b>week1</b> + <a class="ansibleOptionLink" href="#parameter-week1" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, repetition period.</div> + <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-week2"></div> + <b>week2</b> + <a class="ansibleOptionLink" href="#parameter-week2" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, repetition period.</div> + <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-week3"></div> + <b>week3</b> + <a class="ansibleOptionLink" href="#parameter-week3" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, repetition period.</div> + <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-week4"></div> + <b>week4</b> + <a class="ansibleOptionLink" href="#parameter-week4" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, repetition period.</div> + <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-week5"></div> + <b>week5</b> + <a class="ansibleOptionLink" href="#parameter-week5" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>Pause period of add, repetition period.</div> + <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power budget test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power budget range" + ieisystem.inmanage.edit_power_budget: + range: True + provider: "{{ inmanage }}" + + - name: "add power budget" + ieisystem.inmanage.edit_power_budget: + action: "add" + id: 1 + watts: 1500 + start1: 2 + end1: 5 + week1: + - Mon + - Wed + - Fri + provider: "{{ inmanage }}" + + - name: "Set power budget status to open" + ieisystem.inmanage.edit_power_budget: + action: "open" + id: 1 + provider: "{{ inmanage }}" + + - name: "Set power budget status to close" + ieisystem.inmanage.edit_power_budget: + action: "close" + id: 1 + provider: "{{ inmanage }}" + + - name: "Delete power budget" + ieisystem.inmanage.edit_power_budget: + action: "delete" + id: 1 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_power_restore_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_power_restore_module.rst new file mode 100644 index 000000000..9040f60de --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_power_restore_module.rst @@ -0,0 +1,323 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_power_restore_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_power_restore -- Set power restore information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_power_restore`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set power restore information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-option"></div> + <b>option</b> + <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>on</li> + <li>off</li> + <li>restore</li> + </ul> + </td> + <td> + <div>Set power policy option.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power restore test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set power restore information" + ieisystem.inmanage.edit_power_restore: + option: "on" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_power_status_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_power_status_module.rst new file mode 100644 index 000000000..884533719 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_power_status_module.rst @@ -0,0 +1,325 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_power_status_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_power_status -- Set power status information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_power_status`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set power status information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>On</li> + <li>ForceOff</li> + <li>ForcePowerCycle</li> + <li>ForceReset</li> + <li>GracefulShutdown</li> + </ul> + </td> + <td> + <div>Power status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power status test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set power status information" + ieisystem.inmanage.edit_power_status: + state: "On" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_preserve_config_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_preserve_config_module.rst new file mode 100644 index 000000000..82b31c32b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_preserve_config_module.rst @@ -0,0 +1,373 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_preserve_config_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_preserve_config -- Set preserve config +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_preserve_config`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set preserve config on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-override"></div> + <b>override</b> + <a class="ansibleOptionLink" href="#parameter-override" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>authentication</li> + <li>dcmi</li> + <li>fru</li> + <li>hostname</li> + <li>ipmi</li> + <li>kvm</li> + <li>network</li> + <li>ntp</li> + <li>pef</li> + <li>sdr</li> + <li>sel</li> + <li>smtp</li> + <li>snmp</li> + <li>sol</li> + <li>ssh</li> + <li>syslog</li> + <li>user</li> + </ul> + </td> + <td> + <div>Configuration items that need to be retained.</div> + <div>Required when <em>setting=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-setting"></div> + <b>setting</b> + <a class="ansibleOptionLink" href="#parameter-setting" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>all</li> + <li>none</li> + <li>manual</li> + </ul> + </td> + <td> + <div>Preserve option, all - preserve all config; none - overwrite all config; manual - manual choose.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Preserve test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set preserve all" + ieisystem.inmanage.edit_preserve_config: + setting: "all" + provider: "{{ inmanage }}" + + - name: "Set preserve none" + edit_preserve_config: + setting: "none" + provider: "{{ inmanage }}" + + - name: "Set preserve manual" + edit_preserve_config: + setting: "manual" + override: + - fru + - ntp + - network + - user + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_psu_config_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_psu_config_module.rst new file mode 100644 index 000000000..87d5b884f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_psu_config_module.rst @@ -0,0 +1,339 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_psu_config_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_psu_config -- Set psu config information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_psu_config`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set psu config information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-id"></div> + <b>id</b> + <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Power id.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-switch"></div> + <b>switch</b> + <a class="ansibleOptionLink" href="#parameter-switch" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>active</li> + <li>standby</li> + <li>normal</li> + </ul> + </td> + <td> + <div>Power supply mode, active or standby.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu config test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set psu config information" + ieisystem.inmanage.edit_psu_config: + id: 1 + switch: "active" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_psu_peak_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_psu_peak_module.rst new file mode 100644 index 000000000..a4f8d9569 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_psu_peak_module.rst @@ -0,0 +1,343 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_psu_peak_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_psu_peak -- Set psu peak information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_psu_peak`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set psu peak information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Power peak status.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-time"></div> + <b>time</b> + <a class="ansibleOptionLink" href="#parameter-time" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Maximum random time, range of values(1-600), unit(second).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu peak test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set psu peak information" + ieisystem.inmanage.edit_psu_peak: + status: "disable" + provider: "{{ inmanage }}" + + - name: "Set psu peak information" + ieisystem.inmanage.edit_psu_peak: + status: "enable" + time: 10 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_restore_factory_default_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_restore_factory_default_module.rst new file mode 100644 index 000000000..f258888cf --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_restore_factory_default_module.rst @@ -0,0 +1,368 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_restore_factory_default_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_restore_factory_default -- Set preserver config ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_restore_factory_default`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set preserver config on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mode"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>all</li> + <li>none</li> + <li>manual</li> + </ul> + </td> + <td> + <div>Restore factory defaults mode.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-override"></div> + <b>override</b> + <a class="ansibleOptionLink" href="#parameter-override" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>authentication</li> + <li>dcmi</li> + <li>fru</li> + <li>hostname</li> + <li>ipmi</li> + <li>kvm</li> + <li>network</li> + <li>ntp</li> + <li>pef</li> + <li>sdr</li> + <li>sel</li> + <li>smtp</li> + <li>snmp</li> + <li>sol</li> + <li>ssh</li> + <li>syslog</li> + <li>user</li> + </ul> + </td> + <td> + <div>Configuration items that need to be retained.</div> + <div>Required when <em>mode=manual</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Restore default test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set restore default auto" + ieisystem.inmanage.edit_restore_factory_default: + mode: "all" + provider: "{{ inmanage }}" + + - name: "Set restore default manual" + ieisystem.inmanage.edit_restore_factory_default: + mode: "manual" + override: + - fru + - ntp + - network + - user + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_service_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_service_module.rst new file mode 100644 index 000000000..3e9b9b68a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_service_module.rst @@ -0,0 +1,428 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_service_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_service -- Set service settings ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_service`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set service settings on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface"></div> + <b>interface</b> + <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>eth0</li> + <li>eth1</li> + <li>both</li> + <li>bond0</li> + </ul> + </td> + <td> + <div>It shows the interface in which service is running.</div> + <div>The user can choose any one of the available interfaces.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-non_secure_port"></div> + <b>non_secure_port</b> + <a class="ansibleOptionLink" href="#parameter-non_secure_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Used to configure non secure port number for the service.</div> + <div>Port value ranges from 1 to 65535.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secure_port"></div> + <b>secure_port</b> + <a class="ansibleOptionLink" href="#parameter-secure_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Used to configure secure port number for the service.</div> + <div>Port value ranges from 1 to 65535.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-service_name"></div> + <b>service_name</b> + <a class="ansibleOptionLink" href="#parameter-service_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>web</li> + <li>kvm</li> + <li>cd-media</li> + <li>fd-media</li> + <li>hd-media</li> + <li>ssh</li> + <li>telnet</li> + <li>solssh</li> + <li>snmp</li> + <li>vnc</li> + </ul> + </td> + <td> + <div>Displays service name of the selected slot(readonly).</div> + <div>The <em>vnc</em> option is not supported in M5.</div> + <div>The <em>fd-media/telnet/snmp</em> option is not supported in M6.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>active</li> + <li>inactive</li> + </ul> + </td> + <td> + <div>Displays the current status of the service, either active or inactive state.</div> + <div>Check this option to start the inactive service.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-timeout"></div> + <b>timeout</b> + <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Displays the session timeout value of the service.</div> + <div>For web, SSH and telnet service, user can configure the session timeout value.</div> + <div>Web timeout value ranges from 300 to 1800 seconds.</div> + <div>SSH and Telnet timeout value ranges from 60 to 1800 seconds.</div> + <div>Timeout value should be in multiples of 60 seconds.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit service test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit kvm" + ieisystem.inmanage.edit_service: + service_name: "kvm" + state: "active" + timeout: "1200" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_smtp_com_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_smtp_com_module.rst new file mode 100644 index 000000000..b08cb1d22 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_smtp_com_module.rst @@ -0,0 +1,578 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_smtp_com_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_smtp_com -- Set SMTP information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_smtp_com`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set SMTP com information on ieisystem Server. +- Only the M6 models support this feature. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-asset_tag"></div> + <b>asset_tag</b> + <a class="ansibleOptionLink" href="#parameter-asset_tag" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Product asset label.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-email"></div> + <b>email</b> + <a class="ansibleOptionLink" href="#parameter-email" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Sender email.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-event_level"></div> + <b>event_level</b> + <a class="ansibleOptionLink" href="#parameter-event_level" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Info</li> + <li>Warning</li> + <li>Critical</li> + </ul> + </td> + <td> + <div>Events above this level will be sent.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host_name"></div> + <b>host_name</b> + <a class="ansibleOptionLink" href="#parameter-host_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Server name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-serial_number"></div> + <b>serial_number</b> + <a class="ansibleOptionLink" href="#parameter-serial_number" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Serial number.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_auth"></div> + <b>server_auth</b> + <a class="ansibleOptionLink" href="#parameter-server_auth" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SMTP server authentication.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_ip"></div> + <b>server_ip</b> + <a class="ansibleOptionLink" href="#parameter-server_ip" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>SMTP server IP.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_password"></div> + <b>server_password</b> + <a class="ansibleOptionLink" href="#parameter-server_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).</div> + <div>Required when <em>server_auth=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_port"></div> + <b>server_port</b> + <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>SMTP server port, The Identification for retry count configuration(1-65535).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_secure_port"></div> + <b>server_secure_port</b> + <a class="ansibleOptionLink" href="#parameter-server_secure_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>SMTP server secure port, The Identification for retry count configuration(1-65535).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-server_username"></div> + <b>server_username</b> + <a class="ansibleOptionLink" href="#parameter-server_username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>SMTP server Username, length be 4 to 64 bits.</div> + <div>Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div> + <div>Required when <em>server_auth=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-ssl_tls_enable"></div> + <b>ssl_tls_enable</b> + <a class="ansibleOptionLink" href="#parameter-ssl_tls_enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SMTP SSLTLS Enable.</div> + <div><em>ssl_tls_enable=disable</em>, when <em>star_tls_enable=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-star_tls_enable"></div> + <b>star_tls_enable</b> + <a class="ansibleOptionLink" href="#parameter-star_tls_enable" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SMTP STARTTLS Enable.</div> + <div><em>star_tls_enable=disable</em>, when <em>ssl_tls_enable=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SMTP Support.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-subject"></div> + <b>subject</b> + <a class="ansibleOptionLink" href="#parameter-subject" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Email theme.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp com test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp com information" + ieisystem.inmanage.edit_smtp_com: + status: "disable" + provider: "{{ inmanage }}" + + - name: "Set smtp com information" + ieisystem.inmanage.edit_smtp_com: + status: "enable" + server_ip: "100.2.2.2" + email: "ieit@ieisystem.com" + server_auth: "enable" + server_username: "admin" + server_password: "1234qwer!@#$" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_smtp_dest_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_smtp_dest_module.rst new file mode 100644 index 000000000..5177ec8f2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_smtp_dest_module.rst @@ -0,0 +1,383 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_smtp_dest_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_smtp_dest -- Set SMTP information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_smtp_dest`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set SMTP dest information on ieisystem Server. +- Only the M6 models support this feature. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-address"></div> + <b>address</b> + <a class="ansibleOptionLink" href="#parameter-address" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Email address.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-description"></div> + <b>description</b> + <a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Description information.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-id"></div> + <b>id</b> + <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>Email destination id.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-status"></div> + <b>status</b> + <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Email enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp dest test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp dest information" + ieisystem.inmanage.edit_smtp_dest: + id: 1 + status: "disable" + provider: "{{ inmanage }}" + + - name: "Set smtp dest information" + ieisystem.inmanage.edit_smtp_dest: + id: 1 + status: "enable" + address: "100.2.2.2" + description": "test" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_smtp_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_smtp_module.rst new file mode 100644 index 000000000..7390e5a44 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_smtp_module.rst @@ -0,0 +1,587 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_smtp_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_smtp -- Set SMTP information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_smtp`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set SMTP information on ieisystem Server. +- Only the M5 models support this feature. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-email"></div> + <b>email</b> + <a class="ansibleOptionLink" href="#parameter-email" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Sender email.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface"></div> + <b>interface</b> + <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>eth0</li> + <li>eth1</li> + <li>bond0</li> + </ul> + </td> + <td> + <div>LAN Channel, eth0 is shared, eth1 is dedicated.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_auth"></div> + <b>primary_auth</b> + <a class="ansibleOptionLink" href="#parameter-primary_auth" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Primary SMTP server authentication.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_ip"></div> + <b>primary_ip</b> + <a class="ansibleOptionLink" href="#parameter-primary_ip" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Primary SMTP server IP.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_name"></div> + <b>primary_name</b> + <a class="ansibleOptionLink" href="#parameter-primary_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Primary SMTP server name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_password"></div> + <b>primary_password</b> + <a class="ansibleOptionLink" href="#parameter-primary_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Primary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).</div> + <div>Required when <em>primary_auth=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_port"></div> + <b>primary_port</b> + <a class="ansibleOptionLink" href="#parameter-primary_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Primary SMTP server port, The Identification for retry count configuration(1-65535).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_status"></div> + <b>primary_status</b> + <a class="ansibleOptionLink" href="#parameter-primary_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Primary SMTP Support.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-primary_username"></div> + <b>primary_username</b> + <a class="ansibleOptionLink" href="#parameter-primary_username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Primary SMTP server Username, length be 4 to 64 bits.</div> + <div>Must start with letters and cannot contain ', '(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_auth"></div> + <b>secondary_auth</b> + <a class="ansibleOptionLink" href="#parameter-secondary_auth" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Secondary SMTP server authentication.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_ip"></div> + <b>secondary_ip</b> + <a class="ansibleOptionLink" href="#parameter-secondary_ip" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Secondary SMTP server IP.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_name"></div> + <b>secondary_name</b> + <a class="ansibleOptionLink" href="#parameter-secondary_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Secondary SMTP server name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_password"></div> + <b>secondary_password</b> + <a class="ansibleOptionLink" href="#parameter-secondary_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Secondary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).</div> + <div>Required when <em>secondary_auth=enable</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_port"></div> + <b>secondary_port</b> + <a class="ansibleOptionLink" href="#parameter-secondary_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Secondary SMTP server port, The Identification for retry count configuration(1-65535).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_status"></div> + <b>secondary_status</b> + <a class="ansibleOptionLink" href="#parameter-secondary_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Secondary SMTP Support.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-secondary_username"></div> + <b>secondary_username</b> + <a class="ansibleOptionLink" href="#parameter-secondary_username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Secondary SMTP server Username, length be 4 to 64 bits.</div> + <div>Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp information" + ieisystem.inmanage.edit_smtp: + interface: "eth0" + email: "ieit@ieisystem.com" + primary_status: "enable" + primary_ip: "100.2.2.2" + primary_name: "test" + primary_auth: "disable" + provider: "{{ inmanage }}" + + - name: "Set smtp information" + ieisystem.inmanage.edit_smtp: + interface: "eth0" + email: "ieit@ieisystem.com" + primary_status: "enable" + primary_ip: "100.2.2.2" + primary_name: "test" + primary_auth: "enable" + primary_username: "test" + primary_password: my_password + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_snmp_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_snmp_module.rst new file mode 100644 index 000000000..30515f12b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_snmp_module.rst @@ -0,0 +1,540 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_snmp_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_snmp -- Set snmp +++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_snmp`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set snmp on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auth_password"></div> + <b>auth_password</b> + <a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the authentication password for the V3 trap or v3get/v3set.</div> + <div>The password is a string of 8 to 16 alphanumeric characters.</div> + <div>Required when <em>auth_protocol</em> is either <code>SHA</code> or <code>MD5</code>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auth_protocol"></div> + <b>auth_protocol</b> + <a class="ansibleOptionLink" href="#parameter-auth_protocol" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>NONE</li> + <li>SHA</li> + <li>MD5</li> + </ul> + </td> + <td> + <div>Choose the authentication protocol for the V3 trap or v3get/v3set.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-community"></div> + <b>community</b> + <a class="ansibleOptionLink" href="#parameter-community" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Community of v1/v2c or v1get/v1set/v2cget/v2cset.</div> + <div>Only the M5 models support this feature.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-priv_password"></div> + <b>priv_password</b> + <a class="ansibleOptionLink" href="#parameter-priv_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the privacy password for the V3 trap or v3get/v3set.</div> + <div>The password is a string of 8 to 16 alphanumeric characters.</div> + <div>Required when <em>priv_protocol</em> is either <code>DES</code> or <code>AES</code>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-priv_protocol"></div> + <b>priv_protocol</b> + <a class="ansibleOptionLink" href="#parameter-priv_protocol" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>NONE</li> + <li>DES</li> + <li>AES</li> + </ul> + </td> + <td> + <div>Choose the privacy protocol for the V3 trap or v3get/v3set.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-read_community"></div> + <b>read_community</b> + <a class="ansibleOptionLink" href="#parameter-read_community" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Read Only Community, Community should between 1 and 16 characters.</div> + <div>Only the M6 models support this feature.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-read_write_community"></div> + <b>read_write_community</b> + <a class="ansibleOptionLink" href="#parameter-read_write_community" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Read And Write Community, Community should between 1 and 16 characters.</div> + <div>Only the M6 models support this feature.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-snmp_status"></div> + <b>snmp_status</b> + <a class="ansibleOptionLink" href="#parameter-snmp_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + </td> + <td> + <div>NMP read/write status of customize.</div> + <div>The input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set', separated by commas, such as v1get, v1set, v2cget.</div> + <div>Only the M5 models support this feature.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-v1status"></div> + <b>v1status</b> + <a class="ansibleOptionLink" href="#parameter-v1status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SNMP V1 enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-v2status"></div> + <b>v2status</b> + <a class="ansibleOptionLink" href="#parameter-v2status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SNMP V2 enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-v3status"></div> + <b>v3status</b> + <a class="ansibleOptionLink" href="#parameter-v3status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>SNMP V3 enable.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-v3username"></div> + <b>v3username</b> + <a class="ansibleOptionLink" href="#parameter-v3username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set a username for the V3 trap or v3get/v3set.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-version"></div> + <b>version</b> + <a class="ansibleOptionLink" href="#parameter-version" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + <li>4</li> + </ul> + </td> + <td> + <div>SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.</div> + <div>Only the M5 models support this feature.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Snmp test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set snmp get/set" + ieisystem.inmanage.edit_snmp: + community: "test" + v3username: "test" + provider: "{{ inmanage }}" + + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_snmp_trap_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_snmp_trap_module.rst new file mode 100644 index 000000000..544f48a58 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_snmp_trap_module.rst @@ -0,0 +1,598 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_snmp_trap_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_snmp_trap -- Set snmp trap +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_snmp_trap`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set snmp trap on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auth_password"></div> + <b>auth_password</b> + <a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the authentication password for the V3 trap.</div> + <div>The password is a string of 8 to 16 alphanumeric characters.</div> + <div>Required when <em>auth_protocol</em> is either <code>SHA</code> or <code>MD5</code>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-auth_protocol"></div> + <b>auth_protocol</b> + <a class="ansibleOptionLink" href="#parameter-auth_protocol" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>NONE</li> + <li>SHA</li> + <li>MD5</li> + </ul> + </td> + <td> + <div>Choose the authentication protocol for the V3 trap.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-community"></div> + <b>community</b> + <a class="ansibleOptionLink" href="#parameter-community" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Community of v1/v2c.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-contact"></div> + <b>contact</b> + <a class="ansibleOptionLink" href="#parameter-contact" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the contact, can be NULL.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-engine_id"></div> + <b>engine_id</b> + <a class="ansibleOptionLink" href="#parameter-engine_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies an engine identifier for the V3 trap. The value should be string of 10 to 48 hex characters, must be even, can be NULL.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-event_severity"></div> + <b>event_severity</b> + <a class="ansibleOptionLink" href="#parameter-event_severity" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>all</li> + <li>warning</li> + <li>critical</li> + </ul> + </td> + <td> + <div>Event Severity.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host_id"></div> + <b>host_id</b> + <a class="ansibleOptionLink" href="#parameter-host_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>HostName</li> + <li>SerialNum</li> + <li>AssertTag</li> + </ul> + </td> + <td> + <div>Host id.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-location"></div> + <b>location</b> + <a class="ansibleOptionLink" href="#parameter-location" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the host location, can be NULL.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-os"></div> + <b>os</b> + <a class="ansibleOptionLink" href="#parameter-os" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the host operating system, can be NULL.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-priv_password"></div> + <b>priv_password</b> + <a class="ansibleOptionLink" href="#parameter-priv_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the privacy password for the V3 trap.</div> + <div>The password is a string of 8 to 16 alphanumeric characters.</div> + <div>Required when <em>priv_protocol</em> is either <code>DES</code> or <code>AES</code>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-priv_protocol"></div> + <b>priv_protocol</b> + <a class="ansibleOptionLink" href="#parameter-priv_protocol" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>NONE</li> + <li>DES</li> + <li>AES</li> + </ul> + </td> + <td> + <div>Choose the privacy protocol for the V3 trap.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-system_id"></div> + <b>system_id</b> + <a class="ansibleOptionLink" href="#parameter-system_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the system ID, can be NULL.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-system_name"></div> + <b>system_name</b> + <a class="ansibleOptionLink" href="#parameter-system_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the system name, can be NULL.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-trap_port"></div> + <b>trap_port</b> + <a class="ansibleOptionLink" href="#parameter-trap_port" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Set a port for the SNMP trap in the range of 1 to 65535.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-v3username"></div> + <b>v3username</b> + <a class="ansibleOptionLink" href="#parameter-v3username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set the username for the V3 trap.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-version"></div> + <b>version</b> + <a class="ansibleOptionLink" href="#parameter-version" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + </td> + <td> + <div>SNMP trap version, 1 is v1, 2 is v2c(v2), 3 is v3, 0 is disable snmp trap.</div> + <div>Only the M6 model supports <code>0</code> Settings.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Trap test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set snmp trap v2c" + ieisystem.inmanage.edit_snmp_trap: + version: 2 + event_severity: "warning" + community: "test" + system_name: "ieisystem" + provider: "{{ inmanage }}" + + - name: "Set snmp trap v3" + ieisystem.inmanage.edit_snmp_trap: + version: 3 + event_severity: "all" + v3username: "ieisystem" + engine_id: "1234567890" + auth_protocol: "SHA" + auth_password: "12345678" + priv_protocol: "AES" + priv_password: "123454678" + trap_port: 162 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_threshold_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_threshold_module.rst new file mode 100644 index 000000000..641b9f68e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_threshold_module.rst @@ -0,0 +1,410 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_threshold_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_threshold -- Set threshold information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_threshold`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set threshold information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-lc"></div> + <b>lc</b> + <a class="ansibleOptionLink" href="#parameter-lc" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Lower critical threshold, should be integer.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-lnc"></div> + <b>lnc</b> + <a class="ansibleOptionLink" href="#parameter-lnc" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Lower non critical threshold, should be integer.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-lnr"></div> + <b>lnr</b> + <a class="ansibleOptionLink" href="#parameter-lnr" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Lower non recoverable threshold, should be integer.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-name"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Sensor name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-uc"></div> + <b>uc</b> + <a class="ansibleOptionLink" href="#parameter-uc" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Up critical threshold, should be integer.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-unc"></div> + <b>unc</b> + <a class="ansibleOptionLink" href="#parameter-unc" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Up non critical threshold, should be integer.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-unr"></div> + <b>unr</b> + <a class="ansibleOptionLink" href="#parameter-unr" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Up non recoverable threshold, should be integer.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Threshold test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set threshold information" + ieisystem.inmanage.edit_threshold: + name: "GPU1_Temp" + uc: 94 + unc: 92 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_uid_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_uid_module.rst new file mode 100644 index 000000000..439f5660a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_uid_module.rst @@ -0,0 +1,343 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_uid_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_uid -- Set UID +++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_uid`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set UID on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-led"></div> + <b>led</b> + <a class="ansibleOptionLink" href="#parameter-led" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>on</li> + <li>off</li> + </ul> + </td> + <td> + <div>Turn on or turn off the led.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-time"></div> + <b>time</b> + <a class="ansibleOptionLink" href="#parameter-time" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Set led blink time(second).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: UID test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set uid" + ieisystem.inmanage.edit_uid: + led: "on" + time: 10 + provider: "{{ inmanage }}" + + - name: "Set uid" + ieisystem.inmanage.edit_uid: + led: "off" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_virtual_media_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_virtual_media_module.rst new file mode 100644 index 000000000..63ec1d53b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_virtual_media_module.rst @@ -0,0 +1,511 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_virtual_media_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_virtual_media -- Set virtual media +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_virtual_media`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set virtual media on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-local_media_support"></div> + <b>local_media_support</b> + <a class="ansibleOptionLink" href="#parameter-local_media_support" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Enable</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>To enable or disable Local Media Support, check or uncheck the checkbox respectively.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mount"></div> + <b>mount</b> + <a class="ansibleOptionLink" href="#parameter-mount" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Enable</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>Whether to mount virtual media.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mount_type"></div> + <b>mount_type</b> + <a class="ansibleOptionLink" href="#parameter-mount_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>CD</li> + <li>FD</li> + <li>HD</li> + </ul> + </td> + <td> + <div>Virtual mount type.</div> + <div>The <em>FD</em> option is not supported in M6.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_domain_name"></div> + <b>remote_domain_name</b> + <a class="ansibleOptionLink" href="#parameter-remote_domain_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Remote Domain Name, Domain Name field is optional.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_media_support"></div> + <b>remote_media_support</b> + <a class="ansibleOptionLink" href="#parameter-remote_media_support" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>Enable</li> + <li>Disable</li> + </ul> + </td> + <td> + <div>To enable or disable Remote Media support, check or uncheck the checkbox respectively.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_password"></div> + <b>remote_password</b> + <a class="ansibleOptionLink" href="#parameter-remote_password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Remote Password.</div> + <div>Required when <em>remote_share_type=cifs</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_server_address"></div> + <b>remote_server_address</b> + <a class="ansibleOptionLink" href="#parameter-remote_server_address" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Address of the server where the remote media images are stored.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_share_type"></div> + <b>remote_share_type</b> + <a class="ansibleOptionLink" href="#parameter-remote_share_type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>nfs</li> + <li>cifs</li> + </ul> + </td> + <td> + <div>Share Type of the remote media server either NFS or Samba(CIFS).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_source_path"></div> + <b>remote_source_path</b> + <a class="ansibleOptionLink" href="#parameter-remote_source_path" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Source path to the remote media images..</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-remote_user_name"></div> + <b>remote_user_name</b> + <a class="ansibleOptionLink" href="#parameter-remote_user_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Remote User Name.</div> + <div>Required when <em>remote_share_type=cifs</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-same_settings"></div> + <b>same_settings</b> + <a class="ansibleOptionLink" href="#parameter-same_settings" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + </ul> + </td> + <td> + <div>Same settings with <em>CD</em>, 0 is No, 1 is Yes.</div> + <div>Required when <em>mount_type=0</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set local media" + ieisystem.inmanage.edit_virtual_media: + local_media_support: "Enable" + provider: "{{ inmanage }}" + + - name: "Set remote media" + ieisystem.inmanage.edit_virtual_media: + remote_media_support: "Enable" + mount_type: 'CD' + same_settings: 0 + mount: "Enable" + remote_server_address: "100.2.28.203" + remote_source_path: "/data/nfs/server/" + remote_share_type: "nfs" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/edit_vlan_module.rst b/ansible_collections/ieisystem/inmanage/docs/edit_vlan_module.rst new file mode 100644 index 000000000..10f022376 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/edit_vlan_module.rst @@ -0,0 +1,381 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.edit_vlan_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.edit_vlan -- Set vlan information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.edit_vlan`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set vlan information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-interface_name"></div> + <b>interface_name</b> + <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>eth0</li> + <li>eth1</li> + <li>bond0</li> + </ul> + </td> + <td> + <div>Set interface name. Select the LAN interface to be configured.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-vlan_id"></div> + <b>vlan_id</b> + <a class="ansibleOptionLink" href="#parameter-vlan_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>The Identification for VLAN configuration(2-4094).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-vlan_priority"></div> + <b>vlan_priority</b> + <a class="ansibleOptionLink" href="#parameter-vlan_priority" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>The priority for VLAN configuration(1-7).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-vlan_status"></div> + <b>vlan_status</b> + <a class="ansibleOptionLink" href="#parameter-vlan_status" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Enable or disable vlan.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Vlan test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set vlan information" + ieisystem.inmanage.edit_vlan: + interface_name: "eth0" + vlan_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set vlan information" + ieisystem.inmanage.edit_vlan: + interface_name: "eth0" + vlan_status: "enable" + vlan_id: 2 + vlan_priority: 1 + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/event_log_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/event_log_info_module.rst new file mode 100644 index 000000000..e959d72aa --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/event_log_info_module.rst @@ -0,0 +1,358 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.event_log_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.event_log_info -- Get event log information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.event_log_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get event log information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-count"></div> + <b>count</b> + <a class="ansibleOptionLink" href="#parameter-count" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Get the most recent log of a specified number.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-event_file"></div> + <b>event_file</b> + <a class="ansibleOptionLink" href="#parameter-event_file" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Store logs to a file.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-log_time"></div> + <b>log_time</b> + <a class="ansibleOptionLink" href="#parameter-log_time" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Event log info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get event log information" + ieisystem.inmanage.event_log_info: + log_time: "2020-06-01T12:30+08:00" + provider: "{{ inmanage }}" + + - name: "Get event log information" + ieisystem.inmanage.event_log_info: + count: 30 + provider: "{{ inmanage }}" + + - name: "Get event log information" + ieisystem.inmanage.event_log_info: + event_file: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/event_log_policy_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/event_log_policy_info_module.rst new file mode 100644 index 000000000..0581c3727 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/event_log_policy_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.event_log_policy_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.event_log_policy_info -- Get event log policy information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.event_log_policy_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get event log policy information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Event log policy test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get event log policy information" + ieisystem.inmanage.event_log_policy_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/fan_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/fan_info_module.rst new file mode 100644 index 000000000..fdc24ec33 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/fan_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.fan_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.fan_info -- Get fan information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.fan_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get fan information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fan test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get fan information" + ieisystem.inmanage.fan_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/fru_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/fru_info_module.rst new file mode 100644 index 000000000..59269ccef --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/fru_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.fru_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.fru_info -- Get fru information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.fru_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get fru information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fru info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get fru information" + ieisystem.inmanage.fru_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/fw_version_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/fw_version_info_module.rst new file mode 100644 index 000000000..f0e8e8779 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/fw_version_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.fw_version_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.fw_version_info -- Get firmware version information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.fw_version_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get firmware version information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Firmware version test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get firmware version information" + ieisystem.inmanage.fw_version_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/gpu_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/gpu_info_module.rst new file mode 100644 index 000000000..0a5eb24e4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/gpu_info_module.rst @@ -0,0 +1,303 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.gpu_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.gpu_info -- Get GPU information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.gpu_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get GPU information on ieisystem Server. +- Only the M6 models support this feature. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: GPU test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get gpu information" + ieisystem.inmanage.gpu_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/hard_disk_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/hard_disk_info_module.rst new file mode 100644 index 000000000..e49041e7a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/hard_disk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.hard_disk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.hard_disk_info -- Get hard disk information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.hard_disk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get hard disk information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Hard disk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get hard disk information" + ieisystem.inmanage.hard_disk_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/hba_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/hba_info_module.rst new file mode 100644 index 000000000..21e346c22 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/hba_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.hba_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.hba_info -- Get CPU information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.hba_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get HBA information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: HBA test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get hba information" + ieisystem.inmanage.hba_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/index.rst b/ansible_collections/ieisystem/inmanage/docs/index.rst new file mode 100644 index 000000000..4adacce68 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/index.rst @@ -0,0 +1,149 @@ +:orphan: + +.. _plugins_in_ieisystem.inmanage: + +Plugin Index +============ + +These are the plugins in the ieisystem.inmanage collection + +.. toctree:: + :maxdepth: 1 + + +Modules +------- + +* :ref:`ad_group <ansible_collections.ieisystem.inmanage.ad_group_module>` -- Manage active directory group information +* :ref:`ad_group_info <ansible_collections.ieisystem.inmanage.ad_group_info_module>` -- Get active directory group information +* :ref:`ad_info <ansible_collections.ieisystem.inmanage.ad_info_module>` -- Get active directory information +* :ref:`adapter_info <ansible_collections.ieisystem.inmanage.adapter_info_module>` -- Get adapter information +* :ref:`add_ldisk <ansible_collections.ieisystem.inmanage.add_ldisk_module>` -- Create logical disk +* :ref:`alert_policy_info <ansible_collections.ieisystem.inmanage.alert_policy_info_module>` -- Get alert policy +* :ref:`audit_log_info <ansible_collections.ieisystem.inmanage.audit_log_info_module>` -- Get BMC audit log information +* :ref:`auto_capture_info <ansible_collections.ieisystem.inmanage.auto_capture_info_module>` -- Get auto capture screen information +* :ref:`backplane_info <ansible_collections.ieisystem.inmanage.backplane_info_module>` -- Get disk backplane information +* :ref:`backup <ansible_collections.ieisystem.inmanage.backup_module>` -- Backup server settings +* :ref:`bios_export <ansible_collections.ieisystem.inmanage.bios_export_module>` -- Export BIOS config +* :ref:`bios_import <ansible_collections.ieisystem.inmanage.bios_import_module>` -- Import BIOS config +* :ref:`bios_info <ansible_collections.ieisystem.inmanage.bios_info_module>` -- Get BIOS setup +* :ref:`bmc_info <ansible_collections.ieisystem.inmanage.bmc_info_module>` -- Get BMC information +* :ref:`boot_image_info <ansible_collections.ieisystem.inmanage.boot_image_info_module>` -- Get bmc boot image information +* :ref:`boot_option_info <ansible_collections.ieisystem.inmanage.boot_option_info_module>` -- Get BIOS boot options +* :ref:`clear_audit_log <ansible_collections.ieisystem.inmanage.clear_audit_log_module>` -- Clear BMC audit log +* :ref:`clear_event_log <ansible_collections.ieisystem.inmanage.clear_event_log_module>` -- Clear event log +* :ref:`clear_system_log <ansible_collections.ieisystem.inmanage.clear_system_log_module>` -- Clear BMC system log +* :ref:`collect_blackbox <ansible_collections.ieisystem.inmanage.collect_blackbox_module>` -- Collect blackbox log +* :ref:`collect_log <ansible_collections.ieisystem.inmanage.collect_log_module>` -- Collect logs +* :ref:`connect_media_info <ansible_collections.ieisystem.inmanage.connect_media_info_module>` -- Get remote images redirection information +* :ref:`cpu_info <ansible_collections.ieisystem.inmanage.cpu_info_module>` -- Get CPU information +* :ref:`del_session <ansible_collections.ieisystem.inmanage.del_session_module>` -- Delete session +* :ref:`dns_info <ansible_collections.ieisystem.inmanage.dns_info_module>` -- Get dns information +* :ref:`download_auto_screenshot <ansible_collections.ieisystem.inmanage.download_auto_screenshot_module>` -- Download auto screenshots +* :ref:`download_manual_screenshot <ansible_collections.ieisystem.inmanage.download_manual_screenshot_module>` -- Download manual screenshots +* :ref:`edit_ad <ansible_collections.ieisystem.inmanage.edit_ad_module>` -- Set active directory information +* :ref:`edit_alert_policy <ansible_collections.ieisystem.inmanage.edit_alert_policy_module>` -- Set alert policy +* :ref:`edit_auto_capture <ansible_collections.ieisystem.inmanage.edit_auto_capture_module>` -- Set auto capture screen +* :ref:`edit_bios <ansible_collections.ieisystem.inmanage.edit_bios_module>` -- Set BIOS setup attributes +* :ref:`edit_boot_image <ansible_collections.ieisystem.inmanage.edit_boot_image_module>` -- Set bmc boot image +* :ref:`edit_boot_option <ansible_collections.ieisystem.inmanage.edit_boot_option_module>` -- Set BIOS boot options +* :ref:`edit_connect_media <ansible_collections.ieisystem.inmanage.edit_connect_media_module>` -- Start/Stop virtual media Image +* :ref:`edit_dns <ansible_collections.ieisystem.inmanage.edit_dns_module>` -- Set dns information +* :ref:`edit_event_log_policy <ansible_collections.ieisystem.inmanage.edit_event_log_policy_module>` -- Set event log policy +* :ref:`edit_fan <ansible_collections.ieisystem.inmanage.edit_fan_module>` -- Set fan information +* :ref:`edit_fru <ansible_collections.ieisystem.inmanage.edit_fru_module>` -- Set fru settings +* :ref:`edit_ipv4 <ansible_collections.ieisystem.inmanage.edit_ipv4_module>` -- Set ipv4 information +* :ref:`edit_ipv6 <ansible_collections.ieisystem.inmanage.edit_ipv6_module>` -- Set ipv6 information +* :ref:`edit_kvm <ansible_collections.ieisystem.inmanage.edit_kvm_module>` -- Set KVM +* :ref:`edit_ldap <ansible_collections.ieisystem.inmanage.edit_ldap_module>` -- Set ldap information +* :ref:`edit_ldisk <ansible_collections.ieisystem.inmanage.edit_ldisk_module>` -- Set logical disk +* :ref:`edit_log_setting <ansible_collections.ieisystem.inmanage.edit_log_setting_module>` -- Set bmc system and audit log setting +* :ref:`edit_m6_log_setting <ansible_collections.ieisystem.inmanage.edit_m6_log_setting_module>` -- Set bmc system and audit log setting +* :ref:`edit_manual_capture <ansible_collections.ieisystem.inmanage.edit_manual_capture_module>` -- Set manual capture screen +* :ref:`edit_media_instance <ansible_collections.ieisystem.inmanage.edit_media_instance_module>` -- Set Virtual Media Instance +* :ref:`edit_ncsi <ansible_collections.ieisystem.inmanage.edit_ncsi_module>` -- Set ncsi information +* :ref:`edit_network <ansible_collections.ieisystem.inmanage.edit_network_module>` -- Set network information +* :ref:`edit_network_bond <ansible_collections.ieisystem.inmanage.edit_network_bond_module>` -- Set network bond +* :ref:`edit_network_link <ansible_collections.ieisystem.inmanage.edit_network_link_module>` -- Set network link +* :ref:`edit_ntp <ansible_collections.ieisystem.inmanage.edit_ntp_module>` -- Set NTP +* :ref:`edit_pdisk <ansible_collections.ieisystem.inmanage.edit_pdisk_module>` -- Set physical disk +* :ref:`edit_power_budget <ansible_collections.ieisystem.inmanage.edit_power_budget_module>` -- Set power budget information +* :ref:`edit_power_restore <ansible_collections.ieisystem.inmanage.edit_power_restore_module>` -- Set power restore information +* :ref:`edit_power_status <ansible_collections.ieisystem.inmanage.edit_power_status_module>` -- Set power status information +* :ref:`edit_preserve_config <ansible_collections.ieisystem.inmanage.edit_preserve_config_module>` -- Set preserve config +* :ref:`edit_psu_config <ansible_collections.ieisystem.inmanage.edit_psu_config_module>` -- Set psu config information +* :ref:`edit_psu_peak <ansible_collections.ieisystem.inmanage.edit_psu_peak_module>` -- Set psu peak information +* :ref:`edit_restore_factory_default <ansible_collections.ieisystem.inmanage.edit_restore_factory_default_module>` -- Set preserver config +* :ref:`edit_service <ansible_collections.ieisystem.inmanage.edit_service_module>` -- Set service settings +* :ref:`edit_smtp <ansible_collections.ieisystem.inmanage.edit_smtp_module>` -- Set SMTP information +* :ref:`edit_smtp_com <ansible_collections.ieisystem.inmanage.edit_smtp_com_module>` -- Set SMTP information +* :ref:`edit_smtp_dest <ansible_collections.ieisystem.inmanage.edit_smtp_dest_module>` -- Set SMTP information +* :ref:`edit_snmp <ansible_collections.ieisystem.inmanage.edit_snmp_module>` -- Set snmp +* :ref:`edit_snmp_trap <ansible_collections.ieisystem.inmanage.edit_snmp_trap_module>` -- Set snmp trap +* :ref:`edit_threshold <ansible_collections.ieisystem.inmanage.edit_threshold_module>` -- Set threshold information +* :ref:`edit_uid <ansible_collections.ieisystem.inmanage.edit_uid_module>` -- Set UID +* :ref:`edit_virtual_media <ansible_collections.ieisystem.inmanage.edit_virtual_media_module>` -- Set virtual media +* :ref:`edit_vlan <ansible_collections.ieisystem.inmanage.edit_vlan_module>` -- Set vlan information +* :ref:`event_log_info <ansible_collections.ieisystem.inmanage.event_log_info_module>` -- Get event log information +* :ref:`event_log_policy_info <ansible_collections.ieisystem.inmanage.event_log_policy_info_module>` -- Get event log policy information +* :ref:`fan_info <ansible_collections.ieisystem.inmanage.fan_info_module>` -- Get fan information +* :ref:`fru_info <ansible_collections.ieisystem.inmanage.fru_info_module>` -- Get fru information +* :ref:`fw_version_info <ansible_collections.ieisystem.inmanage.fw_version_info_module>` -- Get firmware version information +* :ref:`gpu_info <ansible_collections.ieisystem.inmanage.gpu_info_module>` -- Get GPU information +* :ref:`hard_disk_info <ansible_collections.ieisystem.inmanage.hard_disk_info_module>` -- Get hard disk information +* :ref:`hba_info <ansible_collections.ieisystem.inmanage.hba_info_module>` -- Get CPU information +* :ref:`kvm_info <ansible_collections.ieisystem.inmanage.kvm_info_module>` -- Get KVM information +* :ref:`ldap_group <ansible_collections.ieisystem.inmanage.ldap_group_module>` -- Manage ldap group information +* :ref:`ldap_group_info <ansible_collections.ieisystem.inmanage.ldap_group_info_module>` -- Get ldap group information +* :ref:`ldap_info <ansible_collections.ieisystem.inmanage.ldap_info_module>` -- Get ldap information +* :ref:`ldisk_info <ansible_collections.ieisystem.inmanage.ldisk_info_module>` -- Get logical disks information +* :ref:`log_setting_info <ansible_collections.ieisystem.inmanage.log_setting_info_module>` -- Get bmc log setting information +* :ref:`media_instance_info <ansible_collections.ieisystem.inmanage.media_instance_info_module>` -- Get Virtual Media Instance information +* :ref:`mem_info <ansible_collections.ieisystem.inmanage.mem_info_module>` -- Get memory information +* :ref:`ncsi_info <ansible_collections.ieisystem.inmanage.ncsi_info_module>` -- Get ncsi information +* :ref:`network_bond_info <ansible_collections.ieisystem.inmanage.network_bond_info_module>` -- Get network bond information +* :ref:`network_info <ansible_collections.ieisystem.inmanage.network_info_module>` -- Get network information +* :ref:`network_link_info <ansible_collections.ieisystem.inmanage.network_link_info_module>` -- Get network link information +* :ref:`ntp_info <ansible_collections.ieisystem.inmanage.ntp_info_module>` -- Get NTP information +* :ref:`onboard_disk_info <ansible_collections.ieisystem.inmanage.onboard_disk_info_module>` -- Get onboard disks information +* :ref:`pcie_info <ansible_collections.ieisystem.inmanage.pcie_info_module>` -- Get PCIE information +* :ref:`pdisk_info <ansible_collections.ieisystem.inmanage.pdisk_info_module>` -- Get physical disks information +* :ref:`power_budget_info <ansible_collections.ieisystem.inmanage.power_budget_info_module>` -- Get power budget information +* :ref:`power_consumption_info <ansible_collections.ieisystem.inmanage.power_consumption_info_module>` -- Get power consumption information +* :ref:`power_restore_info <ansible_collections.ieisystem.inmanage.power_restore_info_module>` -- Get power restore information +* :ref:`power_status_info <ansible_collections.ieisystem.inmanage.power_status_info_module>` -- Get power status information +* :ref:`preserve_config_info <ansible_collections.ieisystem.inmanage.preserve_config_info_module>` -- Get preserve config information +* :ref:`psu_config_info <ansible_collections.ieisystem.inmanage.psu_config_info_module>` -- Get psu config information +* :ref:`psu_info <ansible_collections.ieisystem.inmanage.psu_info_module>` -- Get psu information +* :ref:`psu_peak_info <ansible_collections.ieisystem.inmanage.psu_peak_info_module>` -- Get psu peak information +* :ref:`raid_info <ansible_collections.ieisystem.inmanage.raid_info_module>` -- Get RAID/HBA card and controller information +* :ref:`reset_bmc <ansible_collections.ieisystem.inmanage.reset_bmc_module>` -- BMC reset +* :ref:`reset_kvm <ansible_collections.ieisystem.inmanage.reset_kvm_module>` -- KVM reset +* :ref:`restore <ansible_collections.ieisystem.inmanage.restore_module>` -- Restore server settings +* :ref:`self_test_info <ansible_collections.ieisystem.inmanage.self_test_info_module>` -- Get self test information +* :ref:`sensor_info <ansible_collections.ieisystem.inmanage.sensor_info_module>` -- Get sensor information +* :ref:`server_info <ansible_collections.ieisystem.inmanage.server_info_module>` -- Get server status information +* :ref:`service_info <ansible_collections.ieisystem.inmanage.service_info_module>` -- Get service information +* :ref:`session_info <ansible_collections.ieisystem.inmanage.session_info_module>` -- Get online session information +* :ref:`smtp_info <ansible_collections.ieisystem.inmanage.smtp_info_module>` -- Get SMTP information +* :ref:`snmp_info <ansible_collections.ieisystem.inmanage.snmp_info_module>` -- Get snmp get/set information +* :ref:`snmp_trap_info <ansible_collections.ieisystem.inmanage.snmp_trap_info_module>` -- Get snmp trap information +* :ref:`support_info <ansible_collections.ieisystem.inmanage.support_info_module>` -- Get support information +* :ref:`system_log_info <ansible_collections.ieisystem.inmanage.system_log_info_module>` -- Get BMC system log information +* :ref:`temp_info <ansible_collections.ieisystem.inmanage.temp_info_module>` -- Get temp information +* :ref:`threshold_info <ansible_collections.ieisystem.inmanage.threshold_info_module>` -- Get threshold information +* :ref:`uid_info <ansible_collections.ieisystem.inmanage.uid_info_module>` -- Get UID information +* :ref:`update_cpld <ansible_collections.ieisystem.inmanage.update_cpld_module>` -- Update CPLD +* :ref:`update_fw <ansible_collections.ieisystem.inmanage.update_fw_module>` -- Update firmware +* :ref:`update_psu <ansible_collections.ieisystem.inmanage.update_psu_module>` -- Update PSU +* :ref:`user <ansible_collections.ieisystem.inmanage.user_module>` -- Manage user +* :ref:`user_group <ansible_collections.ieisystem.inmanage.user_group_module>` -- Manage user group +* :ref:`user_group_info <ansible_collections.ieisystem.inmanage.user_group_info_module>` -- Get user group information +* :ref:`user_info <ansible_collections.ieisystem.inmanage.user_info_module>` -- Get user information +* :ref:`virtual_media_info <ansible_collections.ieisystem.inmanage.virtual_media_info_module>` -- Get Virtual Media information +* :ref:`volt_info <ansible_collections.ieisystem.inmanage.volt_info_module>` -- Get volt information + + +.. seealso:: + + List of :ref:`collections <list_of_collections>` with docs hosted here.
\ No newline at end of file diff --git a/ansible_collections/ieisystem/inmanage/docs/kvm_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/kvm_info_module.rst new file mode 100644 index 000000000..663b09012 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/kvm_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.kvm_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.kvm_info -- Get KVM information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.kvm_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get KVM information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: KVM test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get KVM information" + ieisystem.inmanage.kvm_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ldap_group_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ldap_group_info_module.rst new file mode 100644 index 000000000..51a50ec59 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ldap_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ldap_group_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ldap_group_info -- Get ldap group information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ldap_group_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get ldap group information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ldap group information" + ieisystem.inmanage.ldap_group_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ldap_group_module.rst b/ansible_collections/ieisystem/inmanage/docs/ldap_group_module.rst new file mode 100644 index 000000000..2de6cb474 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ldap_group_module.rst @@ -0,0 +1,431 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ldap_group_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ldap_group -- Manage ldap group information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ldap_group`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage ldap group information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-base"></div> + <b>base</b> + <a class="ansibleOptionLink" href="#parameter-base" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Search Base.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm"></div> + <b>kvm</b> + <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Kvm privilege.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-name"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Group name.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-pri"></div> + <b>pri</b> + <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>administrator</li> + <li>user</li> + <li>operator</li> + <li>oem</li> + <li>none</li> + </ul> + </td> + <td> + <div>Group privilege.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>present</b> ←</div></li> + <li>absent</li> + </ul> + </td> + <td> + <div>Whether the ldap group should exist or not, taking action if the state is different from what is stated.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-vm"></div> + <b>vm</b> + <a class="ansibleOptionLink" href="#parameter-vm" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Vmedia privilege.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add ldap group information" + ieisystem.inmanage.ldap_group: + state: "present" + name: "wbs" + base: "cn=manager" + pri: "administrator" + kvm: "enable" + vm: "disable" + provider: "{{ inmanage }}" + + - name: "Set ldap group information" + ieisystem.inmanage.ldap_group: + state: "present" + name: "wbs" + pri: "user" + kvm: "disable" + provider: "{{ inmanage }}" + + - name: "Delete ldap group information" + ieisystem.inmanage.ldap_group: + state: "absent" + name: "wbs" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ldap_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ldap_info_module.rst new file mode 100644 index 000000000..68332e011 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ldap_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ldap_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ldap_info -- Get ldap information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ldap_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get ldap information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ldap information" + ieisystem.inmanage.ldap_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ldisk_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ldisk_info_module.rst new file mode 100644 index 000000000..a2a89647c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ldisk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ldisk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ldisk_info -- Get logical disks information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ldisk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get logical disks information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get logical disks information" + ieisystem.inmanage.ldisk_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/log_setting_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/log_setting_info_module.rst new file mode 100644 index 000000000..179a1f71a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/log_setting_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.log_setting_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.log_setting_info -- Get bmc log setting information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.log_setting_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get bmc log setting information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc log setting test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc log setting information" + ieisystem.inmanage.log_setting_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/media_instance_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/media_instance_info_module.rst new file mode 100644 index 000000000..40a1951f7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/media_instance_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.media_instance_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.media_instance_info -- Get Virtual Media Instance information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.media_instance_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get Virtual Media Instance information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media instance test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get Virtual Media Instance information" + ieisystem.inmanage.media_instance_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/mem_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/mem_info_module.rst new file mode 100644 index 000000000..ac859ff27 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/mem_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.mem_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.mem_info -- Get memory information ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.mem_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get memory information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Memory test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get memory information" + ieisystem.inmanage.mem_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ncsi_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ncsi_info_module.rst new file mode 100644 index 000000000..6519a4f7f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ncsi_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ncsi_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ncsi_info -- Get ncsi information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ncsi_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get ncsi information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NCSI test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ncsi information" + ieisystem.inmanage.ncsi_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/network_bond_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/network_bond_info_module.rst new file mode 100644 index 000000000..548e4e282 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/network_bond_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.network_bond_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.network_bond_info -- Get network bond information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.network_bond_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get network bond information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bond test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network bond information" + ieisystem.inmanage.network_bond_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/network_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/network_info_module.rst new file mode 100644 index 000000000..4bb523cc1 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/network_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.network_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.network_info -- Get network information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.network_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get network information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Network test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network information" + ieisystem.inmanage.network_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/network_link_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/network_link_info_module.rst new file mode 100644 index 000000000..0b897cc2f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/network_link_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.network_link_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.network_link_info -- Get network link information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.network_link_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get network link information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Link test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network link information" + ieisystem.inmanage.network_link_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/ntp_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/ntp_info_module.rst new file mode 100644 index 000000000..86008f37b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/ntp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.ntp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.ntp_info -- Get NTP information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.ntp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get NTP information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NTP test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ntp information" + ieisystem.inmanage.ntp_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/onboard_disk_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/onboard_disk_info_module.rst new file mode 100644 index 000000000..a1836d0e3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/onboard_disk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.onboard_disk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.onboard_disk_info -- Get onboard disks information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.onboard_disk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get onboard disks information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Onboard test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get onboard disks information" + ieisystem.inmanage.onboard_disk_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/pcie_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/pcie_info_module.rst new file mode 100644 index 000000000..f31d0fb32 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/pcie_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.pcie_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.pcie_info -- Get PCIE information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.pcie_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get PCIE information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: PCIE test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get PCIE information" + ieisystem.inmanage.pcie_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/pdisk_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/pdisk_info_module.rst new file mode 100644 index 000000000..f3eae6f2a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/pdisk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.pdisk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.pdisk_info -- Get physical disks information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.pdisk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get physical disks information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Pdisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get physical disks information" + ieisystem.inmanage.pdisk_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/power_budget_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/power_budget_info_module.rst new file mode 100644 index 000000000..c4d467ce4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/power_budget_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.power_budget_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.power_budget_info -- Get power budget information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.power_budget_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power budget information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power budget test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power budget information" + ieisystem.inmanage.power_budget_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/power_consumption_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/power_consumption_info_module.rst new file mode 100644 index 000000000..8aa54b6f2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/power_consumption_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.power_consumption_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.power_consumption_info -- Get power consumption information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.power_consumption_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power consumption information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power consumption test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power consumption information" + ieisystem.inmanage.power_consumption_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/power_restore_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/power_restore_info_module.rst new file mode 100644 index 000000000..93818b8b6 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/power_restore_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.power_restore_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.power_restore_info -- Get power restore information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.power_restore_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power restore information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power restore test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power restore information" + ieisystem.inmanage.power_restore_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/power_status_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/power_status_info_module.rst new file mode 100644 index 000000000..f8274e80b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/power_status_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.power_status_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.power_status_info -- Get power status information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.power_status_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power status information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power status test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power status information" + ieisystem.inmanage.power_status_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/preserve_config_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/preserve_config_info_module.rst new file mode 100644 index 000000000..cb676c447 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/preserve_config_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.preserve_config_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.preserve_config_info -- Get preserve config information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.preserve_config_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get preserve config information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Preserve test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get preserve config information" + ieisystem.inmanage.preserve_config_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/psu_config_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/psu_config_info_module.rst new file mode 100644 index 000000000..39508ba61 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/psu_config_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.psu_config_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.psu_config_info -- Get psu config information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.psu_config_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get psu config information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu config test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu config information" + ieisystem.inmanage.psu_config_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/psu_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/psu_info_module.rst new file mode 100644 index 000000000..08ac7cf7b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/psu_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.psu_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.psu_info -- Get psu information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.psu_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get psu information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu information" + ieisystem.inmanage.psu_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/psu_peak_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/psu_peak_info_module.rst new file mode 100644 index 000000000..90effa602 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/psu_peak_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.psu_peak_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.psu_peak_info -- Get psu peak information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.psu_peak_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get psu peak information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu peak test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu peak information" + ieisystem.inmanage.psu_peak_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/raid_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/raid_info_module.rst new file mode 100644 index 000000000..0850f19dc --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/raid_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.raid_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.raid_info -- Get RAID/HBA card and controller information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.raid_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get RAID/HBA card and controller information information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Raid test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get raid information" + ieisystem.inmanage.raid_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/reset_bmc_module.rst b/ansible_collections/ieisystem/inmanage/docs/reset_bmc_module.rst new file mode 100644 index 000000000..47fc08838 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/reset_bmc_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.reset_bmc_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.reset_bmc -- BMC reset ++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.reset_bmc`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- BMC reset on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Reset bmc test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Reset bmc" + ieisystem.inmanage.reset_bmc: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/reset_kvm_module.rst b/ansible_collections/ieisystem/inmanage/docs/reset_kvm_module.rst new file mode 100644 index 000000000..183937cbb --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/reset_kvm_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.reset_kvm_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.reset_kvm -- KVM reset ++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.reset_kvm`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- KVM reset on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Reset kvm test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Reset kvm" + ieisystem.inmanage.reset_kvm: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/restore_module.rst b/ansible_collections/ieisystem/inmanage/docs/restore_module.rst new file mode 100644 index 000000000..3b9861be4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/restore_module.rst @@ -0,0 +1,348 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.restore_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.restore -- Restore server settings ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.restore`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Restore server settings on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-bak_file"></div> + <b>bak_file</b> + <a class="ansibleOptionLink" href="#parameter-bak_file" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Select backup file or bak folder.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-item"></div> + <b>item</b> + <a class="ansibleOptionLink" href="#parameter-item" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>all</li> + <li>network</li> + <li>dns</li> + <li>service</li> + <li>ntp</li> + <li>smtp</li> + <li>snmptrap</li> + <li>ad</li> + <li>ldap</li> + <li>user</li> + <li>bios</li> + </ul> + </td> + <td> + <div>Select export item.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Restore test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Restore server settings" + ieisystem.inmanage.restore: + bak_file: "/home/wbs/backfile" + item: "all" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/self_test_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/self_test_info_module.rst new file mode 100644 index 000000000..64e5e3c09 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/self_test_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.self_test_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.self_test_info -- Get self test information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.self_test_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get self test information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Self test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get self test information" + ieisystem.inmanage.self_test_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/sensor_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/sensor_info_module.rst new file mode 100644 index 000000000..2fd5d7c57 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/sensor_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.sensor_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.sensor_info -- Get sensor information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.sensor_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get sensor information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Sensor test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get sensor information" + ieisystem.inmanage.sensor_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/server_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/server_info_module.rst new file mode 100644 index 000000000..94e2cf4e4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/server_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.server_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.server_info -- Get server status information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.server_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get server status information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Server test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get server status information" + ieisystem.inmanage.server_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/service_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/service_info_module.rst new file mode 100644 index 000000000..b5e35fe6a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/service_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.service_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.service_info -- Get service information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.service_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get service information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Service info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get service information" + ieisystem.inmanage.service_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/session_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/session_info_module.rst new file mode 100644 index 000000000..49ba5fd64 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/session_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.session_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.session_info -- Get online session information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.session_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get online session information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Session test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get session information" + ieisystem.inmanage.session_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/smtp_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/smtp_info_module.rst new file mode 100644 index 000000000..f6fd85f90 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/smtp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.smtp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.smtp_info -- Get SMTP information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.smtp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get SMTP information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get smtp information" + ieisystem.inmanage.smtp_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/snmp_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/snmp_info_module.rst new file mode 100644 index 000000000..ef58e7c77 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/snmp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.snmp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.snmp_info -- Get snmp get/set information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.snmp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get snmp get/set information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Snmp test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get snmp get/set information" + ieisystem.inmanage.snmp_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/snmp_trap_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/snmp_trap_info_module.rst new file mode 100644 index 000000000..ad7c284e7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/snmp_trap_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.snmp_trap_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.snmp_trap_info -- Get snmp trap information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.snmp_trap_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get snmp trap information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Trap test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get snmp trap information" + ieisystem.inmanage.snmp_trap_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/support_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/support_info_module.rst new file mode 100644 index 000000000..55781b9c4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/support_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.support_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.support_info -- Get support information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.support_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get the ieisystem Server support list information. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Support list test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get support information" + ieisystem.inmanage.support_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/system_log_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/system_log_info_module.rst new file mode 100644 index 000000000..71a5a7690 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/system_log_info_module.rst @@ -0,0 +1,384 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.system_log_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.system_log_info -- Get BMC system log information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.system_log_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BMC system log information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-count"></div> + <b>count</b> + <a class="ansibleOptionLink" href="#parameter-count" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Get the most recent log of a specified number.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-level"></div> + <b>level</b> + <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>alert</b> ←</div></li> + <li>critical</li> + <li>error</li> + <li>notice</li> + <li>warning</li> + <li>debug</li> + <li>emergency</li> + <li>info</li> + </ul> + </td> + <td> + <div>Log level.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-log_time"></div> + <b>log_time</b> + <a class="ansibleOptionLink" href="#parameter-log_time" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-system_file"></div> + <b>system_file</b> + <a class="ansibleOptionLink" href="#parameter-system_file" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Store logs to a file.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc system log info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc system log information" + ieisystem.inmanage.system_log_info: + level: "alert" + log_time: "2020-06-01T12:30+08:00" + provider: "{{ inmanage }}" + + - name: "Get bmc system log information" + ieisystem.inmanage.system_log_info: + count: 30 + provider: "{{ inmanage }}" + + - name: "Get bmc system log information" + ieisystem.inmanage.system_log_info: + system_file: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/temp_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/temp_info_module.rst new file mode 100644 index 000000000..ef4debedf --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/temp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.temp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.temp_info -- Get temp information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.temp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get temp information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Temp test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get temp information" + ieisystem.inmanage.temp_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/threshold_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/threshold_info_module.rst new file mode 100644 index 000000000..eca33328e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/threshold_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.threshold_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.threshold_info -- Get threshold information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.threshold_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get threshold information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Threshold test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get threshold information" + ieisystem.inmanage.threshold_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/uid_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/uid_info_module.rst new file mode 100644 index 000000000..ca26d2e71 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/uid_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.uid_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.uid_info -- Get UID information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.uid_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get UID information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: UID test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get UID information" + ieisystem.inmanage.uid_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/update_cpld_module.rst b/ansible_collections/ieisystem/inmanage/docs/update_cpld_module.rst new file mode 100644 index 000000000..fad252986 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/update_cpld_module.rst @@ -0,0 +1,362 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.update_cpld_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.update_cpld -- Update CPLD ++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.update_cpld`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Update CPLD on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-file_url"></div> + <b>file_url</b> + <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>CPLD image file path.</div> + <div>Required when <em>list=False</em>.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-id"></div> + <b>id</b> + <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>CPLD id.</div> + <div>Required when <em>list=False</em>.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-list"></div> + <b>list</b> + <a class="ansibleOptionLink" href="#parameter-list" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>no</b> ←</div></li> + <li>yes</li> + </ul> + </td> + <td> + <div>Get cpld list.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: CPLD test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get cpld list" + ieisystem.inmanage.update_cpld: + list: True + provider: "{{ inmanage }}" + + - name: "Update cpld" + update_cpld: + id: 1 + file_url: "home/wbs/raw.bin" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/update_fw_module.rst b/ansible_collections/ieisystem/inmanage/docs/update_fw_module.rst new file mode 100644 index 000000000..b6a4c8276 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/update_fw_module.rst @@ -0,0 +1,426 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.update_fw_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.update_fw -- Update firmware ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.update_fw`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Update firmware on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-dual_image"></div> + <b>dual_image</b> + <a class="ansibleOptionLink" href="#parameter-dual_image" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>single</li> + <li><div style="color: blue"><b>dual</b> ←</div></li> + </ul> + </td> + <td> + <div>Update dual image(default) or not.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-has_me"></div> + <b>has_me</b> + <a class="ansibleOptionLink" href="#parameter-has_me" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + </ul> + <b>Default:</b><br/><div style="color: blue">1</div> + </td> + <td> + <div>Update me or not when update bios, only work in INTEL platform, 0-no, 1-yes.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mode"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>Auto</b> ←</div></li> + <li>Manual</li> + </ul> + </td> + <td> + <div>Active mode, Manual or Auto(default).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-over_ride"></div> + <b>over_ride</b> + <a class="ansibleOptionLink" href="#parameter-over_ride" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>0</li> + <li>1</li> + </ul> + <b>Default:</b><br/><div style="color: blue">0</div> + </td> + <td> + <div>Reserve Configurations, 0-reserve, 1-override.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-type"></div> + <b>type</b> + <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>BMC</li> + <li>BIOS</li> + </ul> + </td> + <td> + <div>Firmware type.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-url"></div> + <b>url</b> + <a class="ansibleOptionLink" href="#parameter-url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Firmware image url.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Update fw test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "update bios" + ieisystem.inmanage.update_fw: + url: "/home/wbs/SA5112M5_BIOS_4.1.8_Standard_20200117.bin" + type: "BIOS" + provider: "{{ inmanage }}" + + - name: "update bmc" + ieisystem.inmanage.update_fw: + url: "/home/wbs/SA5112M5_BMC_4.17.7_Standard_20200430" + mode: "Auto" + type: "BMC" + dual_image: "dual" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/update_psu_module.rst b/ansible_collections/ieisystem/inmanage/docs/update_psu_module.rst new file mode 100644 index 000000000..c430b52db --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/update_psu_module.rst @@ -0,0 +1,338 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.update_psu_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.update_psu -- Update PSU ++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.update_psu`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Update psu on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-mode"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>Auto</b> ←</div></li> + <li>Manual</li> + </ul> + </td> + <td> + <div>Server Auto Reset Option, Manual or Auto(default).</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-url"></div> + <b>url</b> + <a class="ansibleOptionLink" href="#parameter-url" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Firmware image url.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Update psu test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "update psu" + ieisystem.inmanage.update_psu: + url: "/home/wbs/CRPS1300D2W_00.01.04_BootLoader_Pri_Sec.hpm" + mode: "Auto" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/user_group_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/user_group_info_module.rst new file mode 100644 index 000000000..903769c1f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/user_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.user_group_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.user_group_info -- Get user group information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.user_group_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get user group information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get user group information" + ieisystem.inmanage.user_group_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/user_group_module.rst b/ansible_collections/ieisystem/inmanage/docs/user_group_module.rst new file mode 100644 index 000000000..aba0c7a87 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/user_group_module.rst @@ -0,0 +1,532 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.user_group_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.user_group -- Manage user group +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.user_group`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage user group on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-debug"></div> + <b>debug</b> + <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Debug diagnose privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-general"></div> + <b>general</b> + <a class="ansibleOptionLink" href="#parameter-general" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>General configuration privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-kvm"></div> + <b>kvm</b> + <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Remote KVM configuration privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-media"></div> + <b>media</b> + <a class="ansibleOptionLink" href="#parameter-media" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Remote media configuration privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-name"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> + </td> + <td> + </td> + <td> + <div>Group name.</div> + <div>The range of group name for M6 model is OEM1, OEM2, OEM3, OEM4.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-power"></div> + <b>power</b> + <a class="ansibleOptionLink" href="#parameter-power" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Power control privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-pri"></div> + <b>pri</b> + <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>administrator</li> + <li>operator</li> + <li>user</li> + <li>oem</li> + <li>none</li> + </ul> + </td> + <td> + <div>Group privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M5 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-security"></div> + <b>security</b> + <a class="ansibleOptionLink" href="#parameter-security" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Security configuration privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-self"></div> + <b>self</b> + <a class="ansibleOptionLink" href="#parameter-self" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Itself configuration privilege.</div> + <div>Required when <em>state=present</em>.</div> + <div>Only the M6 model supports this parameter.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>present</b> ←</div></li> + <li>absent</li> + </ul> + </td> + <td> + <div>Whether the user group should exist or not, taking action if the state is different from what is stated.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add user group" + ieisystem.inmanage.user_group: + state: "present" + name: "test" + pri: "administrator" + provider: "{{ inmanage }}" + + - name: "Set user group" + ieisystem.inmanage.user_group: + state: "present" + name: "test" + pri: "user" + provider: "{{ inmanage }}" + + - name: "Set m6 user group" + ieisystem.inmanage.user_group: + state: "present" + name: "OEM1" + general: "enable" + kvm: "enable" + provider: "{{ inmanage }}" + + - name: "Delete user group" + ieisystem.inmanage.user_group: + state: "absent" + name: "test" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/user_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/user_info_module.rst new file mode 100644 index 000000000..60f629130 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/user_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.user_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.user_info -- Get user information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.user_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get user information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get user information" + ieisystem.inmanage.user_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/user_module.rst b/ansible_collections/ieisystem/inmanage/docs/user_module.rst new file mode 100644 index 000000000..b7bb5c831 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/user_module.rst @@ -0,0 +1,454 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.user_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.user -- Manage user +++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.user`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage user on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-access"></div> + <b>access</b> + <a class="ansibleOptionLink" href="#parameter-access" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>User access.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-email"></div> + <b>email</b> + <a class="ansibleOptionLink" href="#parameter-email" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>User email.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-priv"></div> + <b>priv</b> + <a class="ansibleOptionLink" href="#parameter-priv" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>kvm</li> + <li>vmm</li> + <li>sol</li> + <li>none</li> + </ul> + </td> + <td> + <div>Other user permissions, select one or more from None/KVM/VMM/SOL.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-role_id"></div> + <b>role_id</b> + <a class="ansibleOptionLink" href="#parameter-role_id" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>User group.</div> + <div>Default user group 'Administrator', 'Operator', 'User'.</div> + <div>Use command <code>user_group_info</code> can get all group information.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>present</b> ←</div></li> + <li>absent</li> + </ul> + </td> + <td> + <div>Whether the user should exist or not, taking action if the state is different from what is stated.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-uid"></div> + <b>uid</b> + <a class="ansibleOptionLink" href="#parameter-uid" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>User id, The range is 1 to 16.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-uname"></div> + <b>uname</b> + <a class="ansibleOptionLink" href="#parameter-uname" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>User name, Required when uid is None.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-upass"></div> + <b>upass</b> + <a class="ansibleOptionLink" href="#parameter-upass" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>User password.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add user" + ieisystem.inmanage.user: + state: "present" + uname: "wbs" + upass: "admin" + role_id: "Administrator" + priv: "kvm,sol" + email: "wbs@ieisystem.com" + provider: "{{ inmanage }}" + + - name: "Set user" + ieisystem.inmanage.user: + state: "present" + uname: "wbs" + upass: "12345678" + role_id: "user" + priv: "kvm,sol" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/virtual_media_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/virtual_media_info_module.rst new file mode 100644 index 000000000..d56d4f3ec --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/virtual_media_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.virtual_media_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.virtual_media_info -- Get Virtual Media information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.virtual_media_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get Virtual Media information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get Virtual Media information" + ieisystem.inmanage.virtual_media_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/docs/volt_info_module.rst b/ansible_collections/ieisystem/inmanage/docs/volt_info_module.rst new file mode 100644 index 000000000..f4e3e745a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/volt_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.volt_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.volt_info -- Get volt information +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection <https://galaxy.ansible.com/ieisystem/inmanage>`_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.volt_info`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get volt information on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-provider"></div> + <b>provider</b> + <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dict object containing connection details.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> + <b>host</b> + <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-username"></div> + <b>username</b> + <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> + </td> + </tr> + </table> + <br/> + +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Volt test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get volt information" + ieisystem.inmanage.volt_info: + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-changed"></div> + <b>changed</b> + <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td>always</td> + <td> + <div>Check to see if a change was made on the device.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-message"></div> + <b>message</b> + <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Messages returned after module execution.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-state"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td>always</td> + <td> + <div>Status after module execution.</div> + <br/> + </td> + </tr> + </table> + <br/><br/> + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/ieisystem/inmanage/meta/runtime.yml b/ansible_collections/ieisystem/inmanage/meta/runtime.yml new file mode 100644 index 000000000..86ccce27b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/meta/runtime.yml @@ -0,0 +1,2 @@ +--- +requires_ansible: '>=2.10' diff --git a/ansible_collections/ieisystem/inmanage/plugins/doc_fragments/inmanage.py b/ansible_collections/ieisystem/inmanage/plugins/doc_fragments/inmanage.py new file mode 100644 index 000000000..05faebd2e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/doc_fragments/inmanage.py @@ -0,0 +1,59 @@ +# -*- coding:utf-8 -*- + +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + + +class ModuleDocFragment(object): + + # Standard files documentation fragment + DOCUMENTATION = r''' +options: + provider: + description: + - A dict object containing connection details. + type: dict + suboptions: + host: + description: + - Specifies the DNS host name or address for connecting to the remote + device over the specified transport. The value of host is used as + the destination address for the transport. + type: str + username: + description: + - Configures the username to use to authenticate the connection to + the remote device. If the value is not specified in the task, the value of environment + variable C(ANSIBLE_NET_USERNAME) will be used instead. + type: str + password: + description: + - Specifies the password to use to authenticate the connection to + the remote device. If the value is not specified in the task, the + value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. + type: str + host: + description: + - Specifies the DNS host name or address for connecting to the remote + device over the specified transport. The value of host is used as + the destination address for the transport. + type: str + username: + description: + - Configures the username to use to authenticate the connection to + the remote device. If the value is not specified in the task, the value of environment + variable C(ANSIBLE_NET_USERNAME) will be used instead. + type: str + password: + description: + - Specifies the password to use to authenticate the connection to + the remote device. If the value is not specified in the task, the + value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. + type: str +requirements: + - Python 3.7+ + - inManage +''' diff --git a/ansible_collections/ieisystem/inmanage/plugins/module_utils/inmanage.py b/ansible_collections/ieisystem/inmanage/plugins/module_utils/inmanage.py new file mode 100644 index 000000000..6a7de4787 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/module_utils/inmanage.py @@ -0,0 +1,54 @@ +# -*- coding:utf-8 -*- +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +try: + import inmanage + inmanage_temp = True +except ImportError: + inmanage_temp = False +from ansible.module_utils.basic import env_fallback +from ansible.module_utils.six import iteritems + +inmanage_provider_spec = { + 'host': dict(type='str'), + 'username': dict(type='str', fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])), + 'password': dict(type='str', fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True), +} +inmanage_argument_spec = { + 'provider': dict(type='dict', options=inmanage_provider_spec), +} +inmanage_top_spec = { + 'host': dict(type='str'), + 'username': dict(type='str'), + 'password': dict(type='str', no_log=True), +} +inmanage_argument_spec.update(inmanage_top_spec) + + +def load_params(module): + """load_params""" + provider = module.params.get('provider') or dict() + for key, value in iteritems(provider): + if key in inmanage_argument_spec: + if module.params.get(key) is None and value is not None: + module.params[key] = value + + +def get_connection(module): + """get_connection""" + load_params(module) + # result = dict() + # if module.check_mode: + # result['changed'] = True + # result['state'] = 'Success' + # result['message'] = module.params['subcommand'] + # else: + dict_param = module.params + if not inmanage_temp: + module.fail_json(msg='inmanage_sdk must be installed to use this module') + result = inmanage.main(dict_param) + return result diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ad_group.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ad_group.py new file mode 100644 index 000000000..c41c001df --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ad_group.py @@ -0,0 +1,158 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ad_group +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Manage active directory group information +description: + - Manage active directory group information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + state: + description: + - Whether the active directory group should exist or not, taking action if the state is different from what is stated. + choices: ['present', 'absent'] + default: present + type: str + name: + description: + - Enter the Role Group Name. This name identifies the role group in Active Directory. + type: str + required: true + domain: + description: + - Enter the Role Group Domain. This is the domain where the role group is located. + type: str + pri: + description: + - Enter the Role Group Privilege. This is the level of privilege to be assigned for this role group. + choices: ['administrator', 'user', 'operator', 'oem', 'none'] + type: str + kvm: + description: + - This field provides access to KVM for AD authenticated role group user. + choices: ['enable', 'disable'] + type: str + vm: + description: + - This field provides access to VMedia for AD authenticated role group user. + choices: ['enable', 'disable'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ad group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add active directory group information" + ieisystem.inmanage.ad_group: + state: "present" + name: "wbs" + domain: "test.com" + pri: "administrator" + kvm: "enable" + vm: "disable" + provider: "{{ inmanage }}" + + - name: "Set active directory group information" + ieisystem.inmanage.ad_group: + state: "present" + name: "wbs" + pri: "user" + kvm: "disable" + provider: "{{ inmanage }}" + + - name: "Delete active directory group information" + ieisystem.inmanage.ad_group: + state: "absent" + name: "wbs" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class AD(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'editadgroup' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + state=dict(type='str', choices=['present', 'absent'], default='present'), + name=dict(type='str', required=True), + domain=dict(type='str', required=False), + pri=dict(type='str', required=False, choices=['administrator', 'user', 'operator', 'oem', 'none']), + kvm=dict(type='str', required=False, choices=['enable', 'disable']), + vm=dict(type='str', required=False, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + ad_obj = AD(argument_spec) + ad_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ad_group_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ad_group_info.py new file mode 100644 index 000000000..190532cb7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ad_group_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ad_group_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get active directory group information +description: + - Get active directory group information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ad group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get active directory group information" + ieisystem.inmanage.ad_group_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class AD(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getadgroup' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + ad_obj = AD(argument_spec) + ad_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ad_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ad_info.py new file mode 100644 index 000000000..1af4c105c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ad_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ad_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get active directory information +description: + - Get active directory information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ad test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get active directory information" + ieisystem.inmanage.ad_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class AD(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getad' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + ad_obj = AD(argument_spec) + ad_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/adapter_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/adapter_info.py new file mode 100644 index 000000000..ce4b0830d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/adapter_info.py @@ -0,0 +1,119 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: adapter_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get adapter information +description: + - Get adapter information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Adapter test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get adapter information" + ieisystem.inmanage.adapter_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Adapter(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getnic' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + nic_result = self.results + if nic_result['State'] == "Success": + nic = nic_result['Message'][0] + sysadapter_len = nic.get('Maximum', 0) + idx = 0 + sortedRes = dict() + if sysadapter_len > 0: + nic = nic.get('NIC', []) + List = [] + while idx < sysadapter_len: + nic_info = nic[idx] + sysadapter_info = nic_info.get('Controller') + List.extend(sysadapter_info) + idx = idx + 1 + sortedRes["State"] = "Success" + sortedRes["Message"] = List + else: + sortedRes["State"] = "Failure" + sortedRes["Message"] = "cannot get information" + self.module.exit_json(**sortedRes) + else: + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + adapter_obj = Adapter(argument_spec) + adapter_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/add_ldisk.py b/ansible_collections/ieisystem/inmanage/plugins/modules/add_ldisk.py new file mode 100644 index 000000000..ec33ac00a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/add_ldisk.py @@ -0,0 +1,221 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: add_ldisk +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Create logical disk +description: + - Create logical disk on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + ctrl_id: + description: + - Raid controller ID. + - Required when controller type is LSI, PMC or MV. + type: int + level: + description: + - RAID Level, 0 - RAID0, 1 - RAID1, 5 - RAID5, 6 - RAID6, 10 - RAID10. + - Required when controller type is LSI or PMC. + choices: [0, 1, 5, 6, 10] + type: int + size: + description: + - Strip Size, 0 - 32k, 1 - 64k, 2 - 128k, 3 - 256k, 4 - 512k, 5 - 1024k. + - Required when controller type is LSI, PMC or MV. + - When the controller type is MV, size is [0, 1]. + - When the controller type is LSI or PMC, size is [1, 2, 3, 4, 5]. + choices: [0, 1, 2, 3, 4, 5] + type: int + access: + description: + - Access Policy, 1 - Read Write, 2 - Read Only, 3 - Blocked. + - Required when controller type is LSI. + choices: [1, 2, 3] + type: int + r: + description: + - Read Policy, 1 - Read Ahead, 2 - No Read Ahead. + - Required when controller type is LSI. + choices: [1, 2] + type: int + w: + description: + - Write Policy, 1 - Write Through, 2 - Write Back, 3 - Write caching ok if bad BBU. + - Required when controller type is LSI. + choices: [1, 2, 3] + type: int + io: + description: + - IO Policy, 1 - Direct IO, 2 - Cached IO. + - Required when controller type is LSI. + choices: [1, 2] + type: int + cache: + description: + - Drive Cache, 1 - Unchanged, 2 - Enabled, 3 - Disabled. + - Required when controller type is LSI. + choices: [1, 2, 3] + type: int + init: + description: + - Init State, 1 - No Init, 2 - Quick Init, 3 - Full Init. + - Required when controller type is LSI. + choices: [1, 2, 3] + type: int + select: + description: + - Select Size, from 1 to 100. + - Required when controller type is LSI. + type: int + slot: + description: + - Slot Num, input multiple slotNumber like 0, 1, 2.... + - Required when controller type is LSI or PMC. + type: list + elements: int + accelerator: + description: + - Driver accelerator, 1 - 1h, 2 - 2h, 3 - 3h. + - Required when controller type is PMC. + choices: [1, 2, 3] + type: int + vname: + description: + - Virtual drive name. + - Required when controller type is PMC or server model is M7. + - Required when controller type is MV. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Add ldisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add LSI ldisk" + ieisystem.inmanage.add_ldisk: + ctrl_id: 0 + level: 1 + size: 1 + access: 1 + r: 1 + w: 1 + io: 1 + cache: 1 + init: 2 + select: 10 + slot: 0,1 + provider: "{{ inmanage }}" + + - name: "Add PMC ldisk" + ieisystem.inmanage.add_ldisk: + ctrl_id: 0 + level: 1 + size: 1 + accelerator: 1 + slot: 0,1 + vname: "test" + provider: "{{ inmanage }}" + + - name: "Add MV ldisk" + ieisystem.inmanage.add_ldisk: + ctrl_id: 0 + size: 1 + vname: "test" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Disk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'addldisk' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + ctrl_id=dict(type='int', required=False), + level=dict(type='int', required=False, choices=[0, 1, 5, 6, 10]), + size=dict(type='int', required=False, choices=[0, 1, 2, 3, 4, 5]), + access=dict(type='int', required=False, choices=[1, 2, 3]), + r=dict(type='int', required=False, choices=[1, 2]), + w=dict(type='int', required=False, choices=[1, 2, 3]), + io=dict(type='int', required=False, choices=[1, 2]), + cache=dict(type='int', required=False, choices=[1, 2, 3]), + init=dict(type='int', required=False, choices=[1, 2, 3]), + select=dict(type='int', required=False), + slot=dict(type='list', elements='int', required=False), + accelerator=dict(type='int', required=False, choices=[1, 2, 3]), + vname=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + disk_obj = Disk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/alert_policy_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/alert_policy_info.py new file mode 100644 index 000000000..f13258cf3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/alert_policy_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: alert_policy_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get alert policy +description: + - Get alert policy on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Alert test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get alert policy" + ieisystem.inmanage.alert_policy_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SNMP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getalertpolicy' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + snmp_obj = SNMP(argument_spec) + snmp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/audit_log_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/audit_log_info.py new file mode 100644 index 000000000..0d0c57a4d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/audit_log_info.py @@ -0,0 +1,126 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: audit_log_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get BMC audit log information +description: + - Get BMC audit log information on ieisystem Server. +notes: + - Supports C(check_mode). +options: + log_time: + description: + - Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00. + type: str + count: + description: + - Get the most recent log of a specified number. + type: int + audit_file: + description: + - Store logs to a file. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bmc audit log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc audit log information" + ieisystem.inmanage.audit_log_info: + log_time: "2020-06-01T12:30+08:00" + provider: "{{ inmanage }}" + + - name: "Get bmc audit log information" + ieisystem.inmanage.audit_log_info: + count: 30 + provider: "{{ inmanage }}" + + - name: "Get bmc audit log information" + ieisystem.inmanage.audit_log_info: + audit_file: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class AuditLog(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getauditlog' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + log_time=dict(type='str', required=False), + count=dict(type='int', required=False), + audit_file=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = AuditLog(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/auto_capture_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/auto_capture_info.py new file mode 100644 index 000000000..774617c6e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/auto_capture_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: auto_capture_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get auto capture screen information +description: + - Get auto capture screen information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get auto capture screen information" + ieisystem.inmanage.auto_capture_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Screen(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getscreen' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + screen_obj = Screen(argument_spec) + screen_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/backplane_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/backplane_info.py new file mode 100644 index 000000000..23746d036 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/backplane_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: backplane_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get disk backplane information +description: + - Get disk backplane information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Disk backplane test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get backplane information" + ieisystem.inmanage.backplane_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Backplane(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getbackplane' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + back_obj = Backplane(argument_spec) + back_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/backup.py b/ansible_collections/ieisystem/inmanage/plugins/modules/backup.py new file mode 100644 index 000000000..8f5c077d8 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/backup.py @@ -0,0 +1,120 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: backup +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Backup server settings +description: + - Backup server settings on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + bak_file: + description: + - Backup file or bak folder. + required: true + type: str + item: + description: + - Export item. + - The values for M5 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', 'ldap', 'user', 'bios'. + - The values for M6 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'kvm', 'ipmi', 'authentication', 'syslog'. + - The values for M7 modules are 'all', 'network', 'service', 'syslog', 'ncsi'. + choices: ['all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', 'ldap', + 'user', 'bios', 'kvm', 'ipmi', 'authentication', 'syslog', 'ncsi'] + required: true + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Backup test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Backup server settings" + ieisystem.inmanage.backup: + bak_file: "/home/wbs/" + item: "all" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Backup(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'backup' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + bak_file=dict(type='str', required=True), + item=dict(type='str', required=True, choices=['all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', + 'ldap', 'user', 'bios', 'kvm', 'ipmi', 'authentication', 'syslog', 'ncsi']), + ) + argument_spec.update(inmanage_argument_spec) + backup_obj = Backup(argument_spec) + backup_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/bios_export.py b/ansible_collections/ieisystem/inmanage/plugins/modules/bios_export.py new file mode 100644 index 000000000..8b783f505 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/bios_export.py @@ -0,0 +1,107 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: bios_export +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Export BIOS config +description: + - Export BIOS config on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + file_url: + description: + - Suffix is .json/.conf, FILEURI format, "/directory/filename". + required: true + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Export bios config" + ieisystem.inmanage.bios_export: + file_url: "/home/wbs/bios.conf" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BIOS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'exportbioscfg' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + file_url=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + bios_obj = BIOS(argument_spec) + bios_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/bios_import.py b/ansible_collections/ieisystem/inmanage/plugins/modules/bios_import.py new file mode 100644 index 000000000..938979a8e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/bios_import.py @@ -0,0 +1,109 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: bios_import +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Import BIOS config +description: + - Import BIOS config on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + file_url: + description: + - Suffix is .json/.conf, FILEURI format, "/directory/filename". + required: true + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Import bios config" + ieisystem.inmanage.bios_import: + file_url: "/home/wbs/bios.conf" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BIOS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'importbioscfg' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + file_url=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + bios_obj = BIOS(argument_spec) + bios_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/bios_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/bios_info.py new file mode 100644 index 000000000..ed0fc37a4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/bios_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: bios_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get BIOS setup +description: + - Get BIOS setup on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bios setup" + ieisystem.inmanage.bios_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BIOS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getbios' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + bios_obj = BIOS(argument_spec) + bios_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/bmc_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/bmc_info.py new file mode 100644 index 000000000..a003a63b9 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/bmc_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: bmc_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get BMC information +description: + - Get BMC information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bmc info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get BMC information" + ieisystem.inmanage.bmc_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BMCInfo(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getbmcinfo' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + bmc_obj = BMCInfo(argument_spec) + bmc_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/boot_image_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/boot_image_info.py new file mode 100644 index 000000000..fca573381 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/boot_image_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: boot_image_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get bmc boot image information +description: + - Get bmc boot image information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Boot image test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc boot image information" + ieisystem.inmanage.boot_image_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Image(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getbootimage' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + image_obj = Image(argument_spec) + image_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/boot_option_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/boot_option_info.py new file mode 100644 index 000000000..c62e6daa3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/boot_option_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: boot_option_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get BIOS boot options +description: + - Get BIOS boot options on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Boot test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bios boot option" + ieisystem.inmanage.boot_option_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BIOS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsysboot' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + bios_obj = BIOS(argument_spec) + bios_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/clear_audit_log.py b/ansible_collections/ieisystem/inmanage/plugins/modules/clear_audit_log.py new file mode 100644 index 000000000..fc4319b6f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/clear_audit_log.py @@ -0,0 +1,101 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: clear_audit_log +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Clear BMC audit log +description: + - Clear BMC audit log on ieisystem Server. +notes: + - Does not support C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Clear BMC audit log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear BMC audit log " + ieisystem.inmanage.clear_audit_log: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class AuditLog(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'clearauditlog' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + log_obj = AuditLog(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/clear_event_log.py b/ansible_collections/ieisystem/inmanage/plugins/modules/clear_event_log.py new file mode 100644 index 000000000..ffdc6f4ef --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/clear_event_log.py @@ -0,0 +1,101 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: clear_event_log +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Clear event log +description: + - Clear event log on ieisystem Server. +notes: + - Does not support C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Clear event log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear event log" + ieisystem.inmanage.clear_event_log: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class EventLog(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'cleareventlog' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + log_obj = EventLog(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/clear_system_log.py b/ansible_collections/ieisystem/inmanage/plugins/modules/clear_system_log.py new file mode 100644 index 000000000..03af9a950 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/clear_system_log.py @@ -0,0 +1,115 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: clear_system_log +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Clear BMC system log +description: + - Clear BMC system log on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + level: + description: + - Log level. + default: alert + choices: ['alert', 'critical', 'error', 'notice', 'warning', 'debug', 'emergency', 'info', 'all'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Clear BMC system log test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear BMC system log" + ieisystem.inmanage.clear_system_log: + level: "alert" + provider: "{{ inmanage }}" + + - name: "Clear BMC system log" + ieisystem.inmanage.clear_system_log: + level: "all" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SystemLog(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'clearsystemlog' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + level=dict(type='str', default='alert', choices=['alert', 'critical', 'error', 'notice', 'warning', 'debug', 'emergency', 'info', 'all']), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = SystemLog(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/collect_blackbox.py b/ansible_collections/ieisystem/inmanage/plugins/modules/collect_blackbox.py new file mode 100644 index 000000000..2dbd30e78 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/collect_blackbox.py @@ -0,0 +1,108 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: collect_blackbox +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Collect blackbox log +description: + - Collect blackbox log on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + file_url: + description: + - File download path. + required: true + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Collect blackbox test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Collect blackbox log" + ieisystem.inmanage.collect_blackbox: + file_url: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" + +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Blackbox(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'collectblackbox' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + file_url=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = Blackbox(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/collect_log.py b/ansible_collections/ieisystem/inmanage/plugins/modules/collect_log.py new file mode 100644 index 000000000..3eaac30b4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/collect_log.py @@ -0,0 +1,107 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: collect_log +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Collect logs +description: + - Collect logs on ieisystem Server, it takes about 5 minutes. +notes: + - Does not support C(check_mode). +options: + file_url: + description: + - File download path or path with filename, for example filepath/filename.tar. + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Collect test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Collect logs" + ieisystem.inmanage.collect_log: + file_url: "/home/wbs/test.tar" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Log(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'collect' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + file_url=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = Log(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/connect_media_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/connect_media_info.py new file mode 100644 index 000000000..94515794d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/connect_media_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: connect_media_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get remote images redirection information +description: + - Get remote images redirection information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Connect media test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get remote images redirection information" + ieisystem.inmanage.connect_media_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Connect(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getconnectmedia' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + connect_obj = Connect(argument_spec) + connect_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/cpu_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/cpu_info.py new file mode 100644 index 000000000..ff2594732 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/cpu_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: cpu_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get CPU information +description: + - Get CPU information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: CPU test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get cpu information" + ieisystem.inmanage.cpu_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class CPU(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getcpu' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + cpu_obj = CPU(argument_spec) + cpu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/del_session.py b/ansible_collections/ieisystem/inmanage/plugins/modules/del_session.py new file mode 100644 index 000000000..95dd0f806 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/del_session.py @@ -0,0 +1,109 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: del_session +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Delete session +description: + - Delete session on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + sid: + description: + - Session Id, input "all" to delete all sessions. + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Delete session test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Delete session" + ieisystem.inmanage.del_session: + sid: "223" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Session(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'delsession' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + sid=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + session_obj = Session(argument_spec) + session_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/dns_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/dns_info.py new file mode 100644 index 000000000..07de2989f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/dns_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: dns_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get dns information +description: + - Get dns information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: DNS test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get dns information" + ieisystem.inmanage.dns_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class DNS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getdns' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + dns_obj = DNS(argument_spec) + dns_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/download_auto_screenshot.py b/ansible_collections/ieisystem/inmanage/plugins/modules/download_auto_screenshot.py new file mode 100644 index 000000000..7d44166ab --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/download_auto_screenshot.py @@ -0,0 +1,107 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: download_auto_screenshot +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Download auto screenshots +description: + - Download auto screenshots on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + file_url: + description: + - Screen capture file path. + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Download auto screenshots" + ieisystem.inmanage.download_auto_screenshot: + file_url: "/home/wbs/screen" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Screen(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'downscreen' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + file_url=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + screen_obj = Screen(argument_spec) + screen_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/download_manual_screenshot.py b/ansible_collections/ieisystem/inmanage/plugins/modules/download_manual_screenshot.py new file mode 100644 index 000000000..be98cba9f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/download_manual_screenshot.py @@ -0,0 +1,107 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: download_manual_screenshot +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Download manual screenshots +description: + - Download manual screenshots on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + file_url: + description: + - Screen capture file path. + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Download manual screenshots" + ieisystem.inmanage.download_manual_screenshot: + file_url: "/home/wbs/screen" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Screen(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'downscreenmanual' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + file_url=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + screen_obj = Screen(argument_spec) + screen_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ad.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ad.py new file mode 100644 index 000000000..3d6a2a23a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ad.py @@ -0,0 +1,163 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ad +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set active directory information +description: + - Set active directory information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + enable: + description: + - Active Directory Authentication Status. + choices: ['enable', 'disable'] + type: str + ssl_enable: + description: + - Active Directory SSL Status. + choices: ['enable', 'disable'] + type: str + name: + description: + - Secret Username. Specify the Username of an administrator of the Active Directory Server. + type: str + code: + description: + - Secret Password. Specify the Password of the administrator. + type: str + timeout: + description: + - The Time Out configuration(15-300). + - Only the M5 model supports this parameter. + type: int + domain: + description: + - User Domain Name. Specify the Domain Name for the user for example MyDomain.com. + type: str + addr1: + description: + - Domain Controller Server Address1. Enter the IP address of Active Directory server. + type: str + addr2: + description: + - Domain Controller Server Address2. Enter the IP address of Active Directory server. + type: str + addr3: + description: + - Domain Controller Server Address3. Enter the IP address of Active Directory server. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ad test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set active directory information" + ieisystem.inmanage.edit_ad: + enable: "disable" + provider: "{{ inmanage }}" + + - name: "Set active directory information" + ieisystem.inmanage.edit_ad: + enable: "enable" + name: "test" + code: "123456" + timeout: 120 + domain: "test.com" + addr1: "100.2.2.2" + addr2: "100.2.2.3" + addr3: "100.2.2.4" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class AD(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setad' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + enable=dict(type='str', required=False, choices=['enable', 'disable']), + ssl_enable=dict(type='str', required=False, choices=['enable', 'disable']), + name=dict(type='str', required=False), + code=dict(type='str', required=False), + timeout=dict(type='int', required=False), + domain=dict(type='str', required=False), + addr1=dict(type='str', required=False), + addr2=dict(type='str', required=False), + addr3=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + ad_obj = AD(argument_spec) + ad_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_alert_policy.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_alert_policy.py new file mode 100644 index 000000000..69813479f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_alert_policy.py @@ -0,0 +1,156 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_alert_policy +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set alert policy +description: + - Set alert policy on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + id: + description: + - Alert id. Customize the channel for sending alarms in Trap. + - The values for M5 modules are 1, 2, 3. + - The values for M6 modules are 1, 2, 3, 4. + choices: [1, 2, 3, 4] + required: true + type: int + status: + description: + - Alert policy status. Whether to enable the receiving end for sending messages in trap mode. + choices: ['enable', 'disable'] + type: str + type: + description: + - Alert Type. + - Only the M5 model supports this parameter. + choices: ['snmp', 'email', 'snmpdomain'] + type: str + destination: + description: + - Alert destination. The address of the server receiving trap information sent by Trap. + - When type is snmp, specify an IP address. + - When type is email, specify a username. + - When type is snmpdomain, specify a domain. + type: str + channel: + description: + - LAN Channel. + - Only the M5 model supports this parameter. + choices: ['shared', 'dedicated'] + type: str + trap_port: + description: + - SNMP trap port(1-65535). + - Only the M6 model supports this parameter. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Alert policy test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set alert policy" + ieisystem.inmanage.edit_alert_policy: + id: 1 + status: "enable" + type: "snmp" + destination: "100.2.2.2" + channel: "shared" + provider: "{{ inmanage }}" + + - name: "Set alert policy" + ieisystem.inmanage.edit_alert_policy: + id: 1 + status: "disable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SNMP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setalertpolicy' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + id=dict(type='int', required=True, choices=[1, 2, 3, 4]), + status=dict(type='str', required=False, choices=['enable', 'disable']), + type=dict(type='str', required=False, choices=['snmp', 'email', 'snmpdomain']), + destination=dict(type='str', required=False), + channel=dict(type='str', required=False, choices=['shared', 'dedicated']), + trap_port=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + snmp_obj = SNMP(argument_spec) + snmp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_auto_capture.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_auto_capture.py new file mode 100644 index 000000000..6158ff27c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_auto_capture.py @@ -0,0 +1,110 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_auto_capture +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set auto capture screen +description: + - Set auto capture screen on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + status: + description: + - Capture status. + choices: ['enable', 'disable'] + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set auto capture screen" + ieisystem.inmanage.edit_auto_capture: + status: "enable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Screen(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setscreen' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + status=dict(type='str', required=True, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + screen_obj = Screen(argument_spec) + screen_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_bios.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_bios.py new file mode 100644 index 000000000..0badfd760 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_bios.py @@ -0,0 +1,134 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_bios +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set BIOS setup attributes +description: + - Set BIOS setup attributes on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + list: + description: + - Show attribute name and configurable value. + default: False + type: bool + attribute: + description: + - BIOS setup option. + - Required when I(list=False) and I(file_url=None). + type: str + value: + description: + - BIOS setup option value. + - Required when I(list=False) and I(file_url=None). + type: str + file_url: + description: + - BIOS option file. attribute must be used with value. + - Mutually exclusive with fileurl format, "/directory/filename". + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bios test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bios setup" + ieisystem.inmanage.edit_bios: + attribute: "VMX" + value: "Disable" + provider: "{{ inmanage }}" + + - name: "Set bios setup" + ieisystem.inmanage.edit_bios: + attribute: "VMX" + value: "Enable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BIOS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setbios' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + list=dict(type='bool', required=False, default=False), + attribute=dict(type='str', required=False), + value=dict(type='str', required=False), + file_url=dict(type='str', required=False) + ) + argument_spec.update(inmanage_argument_spec) + bios_obj = BIOS(argument_spec) + bios_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_boot_image.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_boot_image.py new file mode 100644 index 000000000..356987a58 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_boot_image.py @@ -0,0 +1,111 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_boot_image +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set bmc boot image +description: + - Set bmc boot image on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + image: + description: + - BMC boot image. + - 0-Higher firmware version; 1-Image 1; 2-Image 2; 3-Lower firmware version; 4-Latest updated firmware; 5-Not latest updated firmware. + choices: [0, 1, 2, 3, 4, 5] + type: int + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Boot image test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bmc boot image" + ieisystem.inmanage.edit_boot_image: + image: 2 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Image(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setbootimage' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + image=dict(type='int', required=True, choices=[0, 1, 2, 3, 4, 5]), + ) + argument_spec.update(inmanage_argument_spec) + image_obj = Image(argument_spec) + image_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_boot_option.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_boot_option.py new file mode 100644 index 000000000..88e2865c1 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_boot_option.py @@ -0,0 +1,123 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_boot_option +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set BIOS boot options +description: + - Set BIOS boot options on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + device: + description: + - Boot device. + choices: ['none', 'HDD', 'PXE', 'CD', 'BIOSSETUP'] + type: str + effective: + description: + - Effective, once or continuous. + choices: ['Once', 'Continuous'] + type: str + mode: + description: + - Boot type. + choices: ['Legacy', 'UEFI'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Boot test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bios boot option" + ieisystem.inmanage.edit_boot_option: + device: "PXE" + effective: "Once" + mode: "Legacy" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class BIOS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setsysboot' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + device=dict(type='str', required=False, choices=['none', 'HDD', 'PXE', 'CD', 'BIOSSETUP']), + effective=dict(type='str', required=False, choices=['Once', 'Continuous']), + mode=dict(type='str', required=False, choices=['Legacy', 'UEFI']) + ) + argument_spec.update(inmanage_argument_spec) + bios_obj = BIOS(argument_spec) + bios_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_connect_media.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_connect_media.py new file mode 100644 index 000000000..018cab601 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_connect_media.py @@ -0,0 +1,126 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_connect_media +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Start/Stop virtual media Image +description: + - Start/Stop virtual media Image on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + image_type: + description: + - Virtual media type. + - Only the M5 model supports this parameter. + choices: ['CD', 'FD', 'HD'] + type: str + required: true + op_type: + description: + - Start or stop media. + choices: ['start', 'stop'] + type: str + required: true + image_name: + description: + - Image name. + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Connect media test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set remote image redirection" + ieisystem.inmanage.edit_connect_media: + image_type: "CD" + op_type: "start" + image_name: "aa.iso" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Connect(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setconnectmedia' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + image_type=dict(type='str', required=True, choices=['CD', 'FD', 'HD']), + op_type=dict(type='str', required=True, choices=['start', 'stop']), + image_name=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + connect_obj = Connect(argument_spec) + connect_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_dns.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_dns.py new file mode 100644 index 000000000..aa4efd8ad --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_dns.py @@ -0,0 +1,231 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_dns +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set dns information +description: + - Set dns information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + dns_status: + description: + - DNS status. + choices: ['enable', 'disable'] + type: str + host_cfg: + description: + - Host Settings. Select whether the host name will be configured manually or automatically. + choices: ['manual', 'auto'] + type: str + host_name: + description: + - Host Name. + - Required when I(host_cfg=manual). + type: str + domain_manual: + description: + - Domain Settings. Select whether the domain interface will be configured manually or automatically. + choices: ['manual', 'auto'] + type: str + domain_iface: + description: + - Network Interface, input like 'eth0_v4', 'eth0_v6', 'eth1_v4', 'eth1_v6', 'bond0_v4', 'bond0_v6'. + - Required when I(domain_manual=auto). + type: str + domain_name: + description: + - Domain Name. + - Required when I(domain_manual=manual). + type: str + dns_manual: + description: + - DNS Settings. Select whether the DNS interface will be configured manually or automatically. + choices: ['manual', 'auto'] + type: str + dns_iface: + description: + - DNS Interface, input like 'eth0', 'eth1', 'bond0'. + - Required when I(dns_manual=auto). + type: str + dns_priority: + description: + - IP Priority. + - Required when I(dns_manual=auto). + choices: ['4', '6'] + type: str + dns_server1: + description: + - DNS Server1 IPv4 or IPv6 address. + - Required when I(dns_manual=manual). + type: str + dns_server2: + description: + - DNS Server2 IPv4 or IPv6 address. + - Required when I(dns_manual=manual). + type: str + dns_server3: + description: + - DNS Server3 IPv4 or IPv6 address. + - Required when I(dns_manual=manual). + type: str + register_status1: + description: + - BMC register status 1. + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + registration_method1: + description: + - Registration method 1. + - Only the M6 model supports this parameter. + - Required when I(register_status1=enable). + choices: ['nsupdate', 'dhcp', 'hostname'] + type: str + register_status2: + description: + - BMC register status 2. + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + registration_method2: + description: + - Registration method 2. + - Only the M6 model supports this parameter. + - Required when I(register_status2=enable). + choices: ['nsupdate', 'dhcp', 'hostname'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: DNS test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set dns information" + ieisystem.inmanage.edit_dns: + dns_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set dns information" + ieisystem.inmanage.edit_dns: + dns_status: "enable" + host_cfg: "manual" + host_name: "123456789" + domain_manual: "auto" + domain_iface: "eth0_v4" + dns_manual: "manual" + dns_server1: "100.2.2.2" + dns_server2: "100.2.2.3" + dns_server3: "100.2.2.4" + provider: "{{ inmanage }}" + + - name: "Set dns information" + ieisystem.inmanage.edit_dns: + dns_status: "enable" + host_cfg: "manual" + host_name: "123456789" + domain_manual: "manual" + domain_name: "test.com" + dns_manual: "auto" + dns_iface: "eth0" + dns_priority: "4" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class DNS(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setdns' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + dns_status=dict(type='str', required=False, choices=['enable', 'disable']), + host_cfg=dict(type='str', required=False, choices=['manual', 'auto']), + host_name=dict(type='str', required=False), + domain_manual=dict(type='str', required=False, choices=['manual', 'auto']), + domain_iface=dict(type='str', required=False), + domain_name=dict(type='str', required=False), + dns_manual=dict(type='str', required=False, choices=['manual', 'auto']), + dns_iface=dict(type='str', required=False), + dns_priority=dict(type='str', required=False, choices=['4', '6']), + dns_server1=dict(type='str', required=False), + dns_server2=dict(type='str', required=False), + dns_server3=dict(type='str', required=False), + register_status1=dict(type='str', required=False, choices=['enable', 'disable']), + registration_method1=dict(type='str', required=False, choices=['nsupdate', 'dhcp', 'hostname']), + register_status2=dict(type='str', required=False, choices=['enable', 'disable']), + registration_method2=dict(type='str', required=False, choices=['nsupdate', 'dhcp', 'hostname']), + ) + argument_spec.update(inmanage_argument_spec) + dns_obj = DNS(argument_spec) + dns_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_event_log_policy.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_event_log_policy.py new file mode 100644 index 000000000..f18774796 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_event_log_policy.py @@ -0,0 +1,110 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_event_log_policy +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set event log policy +description: + - Set event log policy on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + policy: + description: + - Event log policy. + choices: ['Linear', 'Circular'] + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Event log policy test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set event log policy" + ieisystem.inmanage.edit_event_log_policy: + policy: "Linear" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Log(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'seteventlogpolicy' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + policy=dict(type='str', required=True, choices=['Linear', 'Circular']), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = Log(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_fan.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_fan.py new file mode 100644 index 000000000..1f36d23e5 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_fan.py @@ -0,0 +1,126 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_fan +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set fan information +description: + - Set fan information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + mode: + description: + - Control mode, Manual or Automatic , Manual must be used with fans_peed. + choices: ['Automatic', 'Manual'] + type: str + id: + description: + - Fan id 255 is for all fans, 0~n. + type: int + fan_speed: + description: + - Fan speed (duty ratio), range in 1 - 100. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Fan test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set fan information" + ieisystem.inmanage.edit_fan: + mode: "Automatic" + provider: "{{ inmanage }}" + + - name: "Set fan information" + ieisystem.inmanage.edit_fan: + mode: "Manual" + id: 1 + fan_speed: 80 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Fan(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'fancontrol' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + mode=dict(type='str', required=False, choices=['Automatic', 'Manual']), + id=dict(type='int', required=False), + fan_speed=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + fan_obj = Fan(argument_spec) + fan_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_fru.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_fru.py new file mode 100644 index 000000000..c89d5d60f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_fru.py @@ -0,0 +1,121 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_fru +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set fru settings +description: + - Set fru settings on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + attribute: + description: + - CP is Chassis Part Number, CS is Chassis Serial, PM is Product Manufacturer. + - PPN is Product Part Number, PS is Product Serial, PN is Product Name. + - PV is Product Version, PAT is Product Asset Tag, BM is Board Mfg, BPN is Board Product Name. + - BS is Board Serial, BP is Board Part Number. + choices: ['CP', 'CS', 'PM', 'PPN', 'PS', 'PN', 'PV', 'PAT', 'BM', 'BPN', 'BS', 'BP'] + required: true + type: str + value: + description: + - Set the value of attribute. + required: true + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Fru test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set Fru" + ieisystem.inmanage.edit_fru: + attribute: "CP" + value: "test" + provider: "{{ inmanage }}" + +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class UID(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setfru' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + attribute=dict(type='str', required=True, choices=['CP', 'CS', 'PM', 'PPN', 'PS', 'PN', 'PV', 'PAT', 'BM', 'BPN', 'BS', 'BP']), + value=dict(type='str', required=True), + ) + argument_spec.update(inmanage_argument_spec) + uid_obj = UID(argument_spec) + uid_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ipv4.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ipv4.py new file mode 100644 index 000000000..95d33ffce --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ipv4.py @@ -0,0 +1,159 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ipv4 +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set ipv4 information +description: + - Set ipv4 information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + interface_name: + description: + - Set interface name. Select the LAN interface to be configured. + choices: ['eth0', 'eth1', 'bond0'] + required: true + type: str + ipv4_status: + description: + - Enable or disable IPV4. + choices: ['enable', 'disable'] + type: str + ipv4_dhcp_enable: + description: + - Enable 'Enable DHCP' to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP). + choices: ['dhcp', 'static'] + type: str + ipv4_address: + description: + - If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface. + - Required when I(ipv4_dhcp_enable=static). + type: str + ipv4_subnet: + description: + - If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface. + - Required when I(ipv4_dhcp_enable=static). + type: str + ipv4_gateway: + description: + - If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface. + - Required when I(ipv4_dhcp_enable=static). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ipv4 test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ipv4 information" + ieisystem.inmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set ipv4 information" + ieisystem.inmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "enable" + ipv4_dhcp_enable: "dhcp" + provider: "{{ inmanage }}" + + - name: "Set ipv4 information" + ieisystem.inmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "enable" + ipv4_dhcp_enable: "static" + ipv4_address: "100.2.36.10" + ipv4_subnet: "255.255.255.0" + ipv4_gateway: "100.2.36.1" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Network(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setipv4' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + interface_name=dict(type='str', required=True, choices=['eth0', 'eth1', 'bond0']), + ipv4_status=dict(type='str', required=False, choices=['enable', 'disable']), + ipv4_dhcp_enable=dict(type='str', required=False, choices=['dhcp', 'static']), + ipv4_address=dict(type='str', required=False), + ipv4_subnet=dict(type='str', required=False), + ipv4_gateway=dict(type='str', required=False), + + ) + argument_spec.update(inmanage_argument_spec) + net_obj = Network(argument_spec) + net_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ipv6.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ipv6.py new file mode 100644 index 000000000..283aadb2d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ipv6.py @@ -0,0 +1,166 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ipv6 +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set ipv6 information +description: + - Set ipv6 information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + interface_name: + description: + - Set interface name. Select the LAN interface to be configured. + choices: ['eth0', 'eth1', 'bond0'] + required: True + type: str + ipv6_status: + description: + - Enable or disable IPV6. + choices: ['enable', 'disable'] + type: str + ipv6_dhcp_enable: + description: + - Enable 'Enable DHCP' to dynamically configure IPv6 address using Dynamic Host Configuration Protocol (DHCP). + choices: ['dhcp', 'static'] + type: str + ipv6_address: + description: + - If DHCP is disabled, specify a static IPv6 address to be configured for the selected interface. + - Required when I(ipv6_dhcp_enable=static). + type: str + ipv6_index: + description: + - Ipv6 index(0-15). + - Required when I(ipv6_dhcp_enable=static). + type: int + ipv6_prefix: + description: + - The subnet prefix length for the IPv6 settings(0-128). + - Required when I(ipv6_dhcp_enable=static). + type: int + ipv6_gateway: + description: + - If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface. + - Required when I(ipv6_dhcp_enable=static). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ipv6 test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ipv6 information" + ieisystem.inmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set ipv6 information" + ieisystem.inmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "enable" + ipv6_dhcp_enable: "dhcp" + provider: "{{ inmanage }}" + + - name: "Set ipv6 information" + ieisystem.inmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "enable" + ipv6_dhcp_enable: "static" + ipv6_address: "::ffff:100:2:36:10" + ipv6_index: 12 + ipv6_prefix: 16 + ipv6_gateway: "::" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Network(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setipv6' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + interface_name=dict(type='str', required=True, choices=['eth0', 'eth1', 'bond0']), + ipv6_status=dict(type='str', required=False, choices=['enable', 'disable']), + ipv6_dhcp_enable=dict(type='str', required=False, choices=['dhcp', 'static']), + ipv6_address=dict(type='str', required=False), + ipv6_index=dict(type='int', required=False), + ipv6_prefix=dict(type='int', required=False), + ipv6_gateway=dict(type='str', required=False), + + ) + argument_spec.update(inmanage_argument_spec) + net_obj = Network(argument_spec) + net_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_kvm.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_kvm.py new file mode 100644 index 000000000..bd711d4f5 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_kvm.py @@ -0,0 +1,191 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_kvm +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set KVM +description: + - Set KVM on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + client_type: + description: + - Client Type. + - Only the M6 model supports this parameter. + choices: ['vnc', 'viewer'] + type: str + kvm_encryption: + description: + - Encrypt KVM packets. + choices: ['enable', 'disable'] + type: str + media_attach: + description: + - Two types of VM attach mode are available. + - Attach is Immediately attaches Virtual Media to the server upon bootup. + - Auto is Attaches Virtual Media to the server only when a virtual media session is started. + - Only the M5 model supports this parameter. + choices: ['attach', 'auto'] + type: str + keyboard_language: + description: + - Select the Keyboard Language. + - AD is Auto Detect, DA is Danish, NL-BE is Dutch Belgium, NL-NL is Dutch Netherland. + - GB is English UK , US is English US, FI is Finnish, FR-BE is French Belgium, FR is French France. + - DE is German Germany, DE-CH is German Switzerland, IT is Italian, JP is Japanese. + - NO is Norwegian, PT is Portuguese, ES is Spanish, SV is Swedish, TR_F is Turkish F, TR_Q is Turkish Q. + choices: ['AD', 'DA', 'NL-BE', 'NL-NL', 'GB', 'US', 'FI', 'FR-BE', 'FR', 'DE', 'DE-CH', 'IT', 'JP', 'ON', 'PT', 'EC', 'SV', 'TR_F', 'TR_Q'] + type: str + retry_count: + description: + - Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20. + - Only the M5 model supports this parameter. + type: int + retry_time_interval: + description: + - The Identification for retry time interval configuration (5-30) seconds. + - Only the M5 model supports this parameter. + type: int + local_monitor_off: + description: + - Server Monitor OFF Feature Status. + choices: ['enable', 'disable'] + type: str + automatic_off: + description: + - Automatically OFF Server Monitor, When KVM Launches. + choices: ['enable', 'disable'] + type: str + non_secure: + description: + - Enable/disable Non Secure Connection Type. + - Only the M6 model supports this parameter. + - Required when I(client_type=vnc). + choices: ['enable', 'disable'] + type: str + ssh_vnc: + description: + - Enable/disable VNC over SSH in BMC. + - Only the M6 model supports this parameter. + - Required when I(client_type=vnc). + choices: ['enable', 'disable'] + type: str + stunnel_vnc: + description: + - Enable/disable VNC over Stunnel in BMC. + - Only the M6 model supports this parameter. + - Required when I(client_type=vnc). + choices: ['enable', 'disable'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: KVM test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set KVM" + ieisystem.inmanage.edit_kvm: + kvm_encryption: "enable" + media_attach: "auto" + keyboard_language: "AD" + retry_count: 13 + retry_time_interval: 10 + local_monitor_off: "enable" + automatic_off: "enable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class KVM(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setkvm' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + client_type=dict(type='str', required=False, choices=['vnc', 'viewer']), + kvm_encryption=dict(type='str', required=False, choices=['enable', 'disable']), + media_attach=dict(type='str', required=False, choices=['attach', 'auto']), + keyboard_language=dict(type='str', required=False, + choices=['AD', 'DA', 'NL-BE', 'NL-NL', 'GB', 'US', 'FI', 'FR-BE', 'FR', + 'DE', 'DE-CH', 'IT', 'JP', 'ON', 'PT', 'EC', 'SV', 'TR_F', 'TR_Q']), + retry_count=dict(type='int', required=False), + retry_time_interval=dict(type='int', required=False), + local_monitor_off=dict(type='str', required=False, choices=['enable', 'disable']), + automatic_off=dict(type='str', required=False, choices=['enable', 'disable']), + non_secure=dict(type='str', required=False, choices=['enable', 'disable']), + ssh_vnc=dict(type='str', required=False, choices=['enable', 'disable']), + stunnel_vnc=dict(type='str', required=False, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + kvm_obj = KVM(argument_spec) + kvm_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ldap.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ldap.py new file mode 100644 index 000000000..310816555 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ldap.py @@ -0,0 +1,193 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ldap +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set ldap information +description: + - Set ldap information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + enable: + description: + - LDAP/E-Directory Authentication Status. + choices: ['enable', 'disable'] + type: str + encry: + description: + - Encryption Type. + choices: ['no', 'SSL', 'StartTLS'] + type: str + address: + description: + - Server Address. + type: str + server_port: + description: + - Server Port. Specify the LDAP/E-Directory Port. + type: int + dn: + description: + - Bind DN. The Bind DN is used in bind operations, which authenticates the client to the server. + - Bind DN is a string of 4 to 64 alphanumeric characters. + - It must start with an alphabetical character. + - Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are allowed. + type: str + code: + description: + - Password. The Bind password is also used in the bind authentication operations between client and server. + - Required when I(enable=enable). + type: str + base: + description: + - Search Base. + - The Search Base allows the LDAP/E-Directory server to find which part of the external directory tree is to be searched. + - This search base may be equivalent to the organization or the group of the external directory. + - Search base is a string of 4 to 64 alphanumeric characters. + - It must start with an alphabetical character. + - Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are allowed. + type: str + attr: + description: + - Attribute of User Login. + - The Attribute of User Login field indicates to the LDAP/E-Directory server which attribute should be used to identify the user. + choices: ['cn', 'uid'] + type: str + cn: + description: + - Common name type. + - Required when I(encry=StartTLS). + choices: ['ip', 'fqdn'] + type: str + ca: + description: + - CA certificate file path. + - Required when I(encry=StartTLS). + type: str + ce: + description: + - Certificate file path. + - Required when I(encry=StartTLS). + type: str + pk: + description: + - Private Key file path. + - Required when I(encry=StartTLS). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ldap test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ldap information" + ieisystem.inmanage.edit_ldap: + enable: "disable" + provider: "{{ inmanage }}" + + - name: "Set ldap information" + ieisystem.inmanage.edit_ldap: + enable: "enable" + encry: "SSL" + address: "100.2.2.2" + server_port: 389 + dn: "cn=manager,ou=login,dc=domain,dc=com" + code: "123456" + base: "cn=manager" + attr: "uid" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LDAP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setldap' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + enable=dict(type='str', required=False, choices=['enable', 'disable']), + encry=dict(type='str', required=False, choices=['no', 'SSL', 'StartTLS']), + address=dict(type='str', required=False), + server_port=dict(type='int', required=False), + dn=dict(type='str', required=False), + code=dict(type='str', required=False), + base=dict(type='str', required=False), + attr=dict(type='str', required=False, choices=['cn', 'uid']), + cn=dict(type='str', required=False, choices=['ip', 'fqdn']), + ca=dict(type='str', required=False), + ce=dict(type='str', required=False), + pk=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + ldap_obj = LDAP(argument_spec) + ldap_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ldisk.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ldisk.py new file mode 100644 index 000000000..f55695640 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ldisk.py @@ -0,0 +1,131 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ldisk +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set logical disk +description: + - Set logical disk on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + ctrl_id: + description: + - Raid controller ID. + type: int + ldisk_id: + description: + - Logical disk ID. + type: int + option: + description: + - Set operation options for a logical disk. + - LOC is Locate Logical Drive, STL is Stop Locate LogicalDrive. + - FI is Fast Initialization, SFI is Slow/Full Initialization. + - SI is Stop Initialization, DEL is Delete LogicalDrive. + choices: ['LOC', 'STL', 'FI', 'SFI', 'SI', 'DEL'] + type: str + duration: + description: + - Duration range is 1-255, physical drive under PMC raid controller. + - Required when I(option=LOC). + - Only the M6 model supports this parameter. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Edit ldisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit ldisk" + ieisystem.inmanage.edit_ldisk: + ctrl_id: 0 + ldisk_id: 1 + option: "LOC" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Disk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setldisk' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + ctrl_id=dict(type='int', required=False), + ldisk_id=dict(type='int', required=False), + option=dict(type='str', required=False, choices=['LOC', 'STL', 'FI', 'SFI', 'SI', 'DEL']), + duration=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + disk_obj = Disk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_log_setting.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_log_setting.py new file mode 100644 index 000000000..b6d3cb54d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_log_setting.py @@ -0,0 +1,164 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_log_setting +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set bmc system and audit log setting +description: + - Set bmc system and audit log setting on ieisystem Server. + - Only the M5 models support this feature. +notes: + - Does not support C(check_mode). +options: + status: + description: + - System Log Status. + choices: ['enable', 'disable'] + type: str + type: + description: + - System log type. + choices: ['local', 'remote', 'both'] + type: str + file_size: + description: + - File Size(3-65535bytes), set when type is local(default 30000). + type: int + audit_status: + description: + - Audit Log Status. + choices: ['enable', 'disable'] + type: str + audit_type: + description: + - Audit log type. + choices: ['local', 'remote', 'both'] + type: str + rotate_count: + description: + - Rotate Count, set when type is local, 0-delete old files(default), 1-bak old files. + choices: [0, 1] + type: int + server_addr: + description: + - Server Address, set when type is remote. + type: str + server_port: + description: + - Server Port(0-65535), set when type is remote. + type: int + protocol_type: + description: + - Protocol Type, set when type is remote. + choices: ['UDP', 'TCP'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Edit log setting test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit bmc system log setting" + ieisystem.inmanage.edit_log_setting: + status: "enable" + type: "both" + provider: "{{ inmanage }}" + + - name: "Edit bmc audit log setting" + ieisystem.inmanage.edit_log_setting: + audit_status: "enable" + audit_type: "remote" + server_addr: "100.2.126.11" + server_port: "514" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LogSetting(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setbmclogsettings' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + status=dict(type='str', required=False, choices=['enable', 'disable']), + type=dict(type='str', required=False, choices=['local', 'remote', 'both']), + file_size=dict(type='int', required=False), + audit_status=dict(type='str', required=False, choices=['enable', 'disable']), + audit_type=dict(type='str', required=False, choices=['local', 'remote', 'both']), + rotate_count=dict(type='int', required=False, choices=[0, 1]), + server_addr=dict(type='str', required=False), + server_port=dict(type='int', required=False), + protocol_type=dict(type='str', required=False, choices=['UDP', 'TCP']), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = LogSetting(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_m6_log_setting.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_m6_log_setting.py new file mode 100644 index 000000000..686c48ae1 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_m6_log_setting.py @@ -0,0 +1,174 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_m6_log_setting +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set bmc system and audit log setting +description: + - Set bmc system and audit log setting on ieisystem Server. + - Only the M6 models support this feature. +notes: + - Does not support C(check_mode). +options: + status: + description: + - System Log Status. + choices: ['enable', 'disable'] + type: str + host_tag: + description: + - System log host tag, set when I(status=enable). + choices: ['HostName', 'SerialNum', 'AssertTag'] + type: str + level: + description: + - Events Level, set when I(status=enable). + choices: ['Critical', 'Warning', 'Info'] + type: str + protocol_type: + description: + - Protocol Type, set when I(status=enable). + choices: ['UDP', 'TCP'] + type: str + server_id: + description: + - Syslog Server ID, set when I(status=enable). + choices: [0, 1, 2, 3] + type: int + server_addr: + description: + - Server Address, set when server_id is not none. + type: str + server_port: + description: + - Server Address, set when server_id is not none. + type: int + log_type: + description: + - Remote Log Type, set when server_id is not none. + choices: ['idl', 'audit', 'both'] + type: str + test: + description: + - Test remote log settings, set when server_id is not none. + default: False + type: bool +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Edit log setting test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit bmc system log setting" + ieisystem.inmanage.edit_m6_log_setting: + status: "disable" + provider: "{{ inmanage }}" + + - name: "Edit bmc audit log setting" + ieisystem.inmanage.edit_m6_log_setting: + status: "enable" + host_tag: "HostName" + level: "Info" + protocol_type: "TCP" + server_id: 0 + server_addr: "100.2.126.11" + server_port: 514 + log_type: "both" + provider: "{{ inmanage }}" + + - name: "test bmc audit log" + ieisystem.inmanage.edit_m6_log_setting: + server_id: 0 + test: True + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LogSetting(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setbmclogcfg' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + status=dict(type='str', required=False, choices=['enable', 'disable']), + host_tag=dict(type='str', required=False, choices=['HostName', 'SerialNum', 'AssertTag']), + level=dict(type='str', required=False, choices=['Critical', 'Warning', 'Info']), + protocol_type=dict(type='str', required=False, choices=['UDP', 'TCP']), + server_id=dict(type='int', required=False, choices=[0, 1, 2, 3]), + server_addr=dict(type='str', required=False), + server_port=dict(type='int', required=False), + log_type=dict(type='str', required=False, choices=['idl', 'audit', 'both']), + test=dict(type='bool', required=False, default=False), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = LogSetting(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_manual_capture.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_manual_capture.py new file mode 100644 index 000000000..c7b4c0dda --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_manual_capture.py @@ -0,0 +1,110 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_manual_capture +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set manual capture screen +description: + - Set manual capture screen on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + type: + description: + - Manual type. + choices: ['capture', 'delete'] + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Screen test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set manual capture screen" + ieisystem.inmanage.edit_manual_capture: + type: "capture" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Screen(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'screenmanual' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + type=dict(type='str', required=True, choices=['capture', 'delete']), + ) + argument_spec.update(inmanage_argument_spec) + screen_obj = Screen(argument_spec) + screen_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_media_instance.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_media_instance.py new file mode 100644 index 000000000..3b43b09f3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_media_instance.py @@ -0,0 +1,167 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_media_instance +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set Virtual Media Instance +description: + - Set Virtual Media Instance on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + num_fd: + description: + - Select the number of floppy devices that support for Virtual Media redirection. + choices: [0, 1, 2, 3, 4] + type: int + num_cd: + description: + - Select the number of CD/DVD devices that support for Virtual Media redirection. + choices: [0, 1, 2, 3, 4] + type: int + num_hd: + description: + - Select the number of harddisk devices that support for Virtual Media redirection. + choices: [0, 1, 2, 3, 4] + type: int + kvm_num_fd: + description: + - Select the number of Remote KVM floppy devices that support for Virtual Media redirection. + choices: [0, 1, 2, 3, 4] + type: int + kvm_num_cd: + description: + - Select the number of Remote KVM CD/DVD devices that support for virtual Media redirection. + - The max support number of html5 KVM is 2 and java KVM is 4. + choices: [0, 1, 2, 3, 4] + type: int + kvm_num_hd: + description: + - Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection. + choices: [0, 1, 2, 3, 4] + type: int + sd_media: + description: + - Check this option to enable SD Media support in BMC. + choices: ['Enable', 'Disable'] + type: str + secure_channel: + description: + - Check this option to enable encrypt media recirection packets. + - Only the M5/M6 model supports this parameter. + choices: ['Enable', 'Disable'] + type: str + power_save_mode: + description: + - Check this option to enable Power Save Mode in BMC. + choices: ['Enable', 'Disable'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Media instance test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set media instance" + ieisystem.inmanage.edit_media_instance: + num_fd: 1 + num_cd: 1 + num_hd: 1 + kvm_num_fd: 1 + kvm_num_cd: 1 + kvm_num_hd: 1 + sd_media: "Enable" + secure_channel: "Enable" + power_save_mode: "Enable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Instance(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setmediainstance' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + num_fd=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + num_cd=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + num_hd=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + kvm_num_fd=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + kvm_num_cd=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + kvm_num_hd=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + sd_media=dict(type='str', required=False, choices=['Enable', 'Disable']), + secure_channel=dict(type='str', required=False, choices=['Enable', 'Disable']), + power_save_mode=dict(type='str', required=False, choices=['Enable', 'Disable']), + ) + argument_spec.update(inmanage_argument_spec) + instance_obj = Instance(argument_spec) + instance_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ncsi.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ncsi.py new file mode 100644 index 000000000..05c1177fb --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ncsi.py @@ -0,0 +1,133 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ncsi +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set ncsi information +description: + - Set ncsi information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + nic_type: + description: + - Nic type. + - Only NF3280A6 and NF3180A6 model supports C(Disable) Settings, but not support C(PHY) Settings. + - M6 model only support C(OCP), C(OCP1), C(PCIE) settings. + choices: ['PHY', 'OCP', 'OCP1', 'PCIE', 'auto', 'Disable'] + type: str + mode: + description: + - NCSI mode, auto-Auto Failover, manual-Manual Switch. + - Only M6 model supports C(Disable) Settings. + choices: ['auto', 'manual', 'Disable'] + type: str + interface_name: + description: + - Interface name, for example eth0. + - Only the M5 model supports this parameter. + type: str + channel_number: + description: + - Channel number. + choices: [0, 1, 2, 3] + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: NCSI test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ncsi information" + ieisystem.inmanage.edit_ncsi: + mode: "manual" + nic_type: "PCIE" + interface_name: "eth0" + channel_number: 1 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class NCSI(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setncsi' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + nic_type=dict(type='str', required=False, choices=['PHY', 'OCP', 'OCP1', 'PCIE', 'auto', 'Disable']), + mode=dict(type='str', required=False, choices=['auto', 'manual', 'Disable']), + interface_name=dict(type='str', required=False), + channel_number=dict(type='int', required=False, choices=[0, 1, 2, 3]), + ) + argument_spec.update(inmanage_argument_spec) + ncsi_obj = NCSI(argument_spec) + ncsi_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network.py new file mode 100644 index 000000000..ef4e00805 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network.py @@ -0,0 +1,118 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_network +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set network information +description: + - Set netowrk information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + interface_name: + description: + - Set interface name. Select the LAN interface to be configured. + choices: ['eth0', 'eth1', 'bond0'] + required: true + type: str + lan_enable: + description: + - Enable or disable this interface. If disable, you cannot use this interface any more. + choices: ['enable', 'disable'] + required: true + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Network test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network information" + ieisystem.inmanage.edit_network: + interface_name: "eth0" + lan_enable: "enable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Network(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setnetwork' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + interface_name=dict(type='str', required=True, choices=['eth0', 'eth1', 'bond0']), + lan_enable=dict(type='str', required=True, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + net_obj = Network(argument_spec) + net_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network_bond.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network_bond.py new file mode 100644 index 000000000..af61eac2e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network_bond.py @@ -0,0 +1,123 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_network_bond +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set network bond +description: + - Set network bond on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + bond: + description: + - Network bond status, If VLAN is enabled for slave interfaces, then Bonding cannot be enabled. + choices: ['enable', 'disable'] + type: str + interface: + description: + - Interface name. + choices: ['shared', 'dedicated', 'both'] + type: str + auto_config: + description: + - Enable this option to configure the interfaces in service configuration automatically. + choices: ['enable', 'disable'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bond test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network bond" + ieisystem.inmanage.edit_network_bond: + bond: "enable" + interface: "dedicated" + auto_config: "enable" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Bond(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setnetworkbond' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + bond=dict(type='str', required=False, choices=['enable', 'disable']), + interface=dict(type='str', required=False, choices=['shared', 'dedicated', 'both']), + auto_config=dict(type='str', required=False, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + bond_obj = Bond(argument_spec) + bond_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network_link.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network_link.py new file mode 100644 index 000000000..2bdec76b4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_network_link.py @@ -0,0 +1,140 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_network_link +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set network link +description: + - Set network link on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + interface: + description: + - Interface name. + choices: ['shared', 'dedicated', 'both'] + type: str + required: true + auto_nego: + description: + - This option allows the device to perform auto-configuration. + - To achieve the best mode of operation (speed and duplex) on the link. + choices: ['enable', 'disable'] + type: str + link_speed: + description: + - Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps. + - Required when I(auto_nego=disable). + choices: [10, 100] + type: int + duplex_mode: + description: + - Select any one of the following Duplex Mode. + - Required when I(auto_nego=disable). + choices: ['HALF', 'FULL'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Link test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network link" + ieisystem.inmanage.edit_network_link: + interface: "dedicated" + auto_nego: "enable" + provider: "{{ inmanage }}" + + - name: "Set network link" + ieisystem.inmanage.edit_network_link: + interface: "dedicated" + auto_nego: "disable" + link_speed: 100 + duplex_mode: "FULL" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Link(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setnetworklink' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + interface=dict(type='str', required=True, choices=['shared', 'dedicated', 'both']), + auto_nego=dict(type='str', required=False, choices=['enable', 'disable']), + link_speed=dict(type='int', required=False, choices=[10, 100]), + duplex_mode=dict(type='str', required=False, choices=['HALF', 'FULL']), + ) + argument_spec.update(inmanage_argument_spec) + link_obj = Link(argument_spec) + link_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ntp.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ntp.py new file mode 100644 index 000000000..1887d1269 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_ntp.py @@ -0,0 +1,173 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_ntp +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set NTP +description: + - Set NTP on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + auto_date: + description: + - Date auto synchronize. + choices: ['enable', 'disable'] + type: str + ntp_time: + description: + - NTP time(YYYYmmddHHMMSS). + - Only the M5 model supports this parameter. + type: str + time_zone: + description: + - UTC time zone, chose from {-12, -11.5, -11, ... , 11, 11.5, 12}. + type: str + server1: + description: + - NTP Server1(ipv4 or ipv6 or domain name), set when auto_date is enable. + type: str + server2: + description: + - NTP Server2(ipv4 or ipv6 or domain name), set when auto_date is enable. + type: str + server3: + description: + - NTP Server3(ipv4 or ipv6 or domain name), set when auto_date is enable. + type: str + server4: + description: + - NTP Server4(ipv4 or ipv6 or domain name), set when auto_date is enable. + type: str + server5: + description: + - NTP Server5(ipv4 or ipv6 or domain name), set when auto_date is enable. + type: str + server6: + description: + - NTP Server6(ipv4 or ipv6 or domain name), set when auto_date is enable. + type: str + syn_cycle: + description: + - NTP syn cycle(minute), sync cycle(5-1440). + type: int + max_variety: + description: + - NTP Maximum jump time(minute), max variety(1-60). + - Only the M6 model supports this parameter. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: NTP test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ntp" + ieisystem.inmanage.edit_ntp: + auto_date: "enable" + server2: "time.nist.gov" + provider: "{{ inmanage }}" + + - name: "Set ntp" + ieisystem.inmanage.edit_ntp: + auto_date: "disable" + ntp_time: "20200609083600" + provider: "{{ inmanage }}" + + - name: "set ntp" + ieisystem.inmanage.edit_ntp: + time_zone: "8" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class NTP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'settime' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + auto_date=dict(type='str', required=False, choices=['enable', 'disable']), + ntp_time=dict(type='str', required=False), + time_zone=dict(type='str', required=False), + server1=dict(type='str', required=False), + server2=dict(type='str', required=False), + server3=dict(type='str', required=False), + server4=dict(type='str', required=False), + server5=dict(type='str', required=False), + server6=dict(type='str', required=False), + syn_cycle=dict(type='int', required=False), + max_variety=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + ntp_obj = NTP(argument_spec) + ntp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_pdisk.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_pdisk.py new file mode 100644 index 000000000..507bc01dd --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_pdisk.py @@ -0,0 +1,178 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_pdisk +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set physical disk +description: + - Set physical disk on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + ctrl_id: + description: + - Raid controller ID. + type: int + device_id: + description: + - Physical drive id. + type: int + option: + description: + - Set operation options for a physical disk. + - UG is Unconfigured Good, UB is Unconfigured Bad. + - OFF is offline, FAIL is Failed, RBD is Rebuild. + - ON is Online, JB is JBOD, ES is Drive Erase stop. + - EM is Drive Erase Simple, EN is Drive Erase Normal. + - ET is Drive Erase Through, LOC is Locate, STL is Stop Locate. + - HS is Hot spare. + - Only the M5 model supports C(HS) Settings. + choices: ['UG', 'UB', 'OFF', 'FAIL', 'RBD', 'ON', 'JB', 'ES', 'EM', 'EN', 'ET', 'LOC', 'STL', 'HS'] + type: str + action: + description: + - Action while set physical drive hotspare. + - Required when I(option=HS). + - Only the M5 model supports this parameter. + choices: ['remove', 'global', 'dedicate'] + type: str + revertible: + description: + - IsRevertible while set physical drive hotspare. + - Required when I(option=HS) and I(action=dedicate). + - Only the M5 model supports this parameter. + choices: ['yes', 'no'] + type: str + encl: + description: + - IsEnclAffinity while set physical drive hotspare. + - Required when I(option=HS) and I(action=dedicate). + - Only the M5 model supports this parameter. + choices: ['yes', 'no'] + type: str + logical_drivers: + description: + - Logical Drivers while set physical drive hotspare, input multiple Logical Drivers index like 0, 1, 2..... + - Required when I(option=HS) and I(action=dedicate). + - Only the M5 model supports this parameter. + type: list + elements: int + duration: + description: + - Duration range is 1-255, physical drive under PMC raid controller. + - Required when I(option=LOC). + - Only the M6 model supports this parameter. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Edit pdisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit pdisk" + ieisystem.inmanage.edit_pdisk: + ctrl_id: 0 + device_id: 1 + option: "LOC" + provider: "{{ inmanage }}" + + - name: "M5 Edit pdisk" + ieisystem.inmanage.edit_pdisk: + ctrl_id: 0 + device_id: 1 + option: "HS" + action: "dedicate" + revertible: "yes" + encl: "yes" + logical_drivers: 1 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Disk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setpdisk' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + ctrl_id=dict(type='int', required=False), + device_id=dict(type='int', required=False), + option=dict(type='str', required=False, choices=['UG', 'UB', 'OFF', 'FAIL', 'RBD', 'ON', 'JB', 'ES', 'EM', 'EN', 'ET', 'LOC', 'STL', 'HS']), + action=dict(type='str', required=False, choices=['remove', 'global', 'dedicate']), + revertible=dict(type='str', required=False, choices=['yes', 'no']), + encl=dict(type='str', required=False, choices=['yes', 'no']), + logical_drivers=dict(type='list', elements='int', required=False), + duration=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + disk_obj = Disk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_budget.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_budget.py new file mode 100644 index 000000000..e67548aa2 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_budget.py @@ -0,0 +1,260 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_power_budget +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set power budget information +description: + - Set power budget information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + range: + description: + - Range of power budget watts. + choices: ['True', 'False'] + default: False + type: bool + domain: + description: + - Domain id. + - Required when I(range=False). + choices: ['system', 'cpu'] + type: str + action: + description: + - Type to action. + - Required when I(range=False). + choices: ['add', 'delete', 'open', 'close'] + type: str + id: + description: + - Policy id. + - Required when I(range=False). + choices: [1, 2, 3, 4] + type: int + watts: + description: + - Power budget watts of add. + - Required when I(action=add). + type: int + except_action: + description: + - Except action, 0 is do nothing, 1 is send alert, 2 is shutdown system, 3 is shutdown system and send alert. + - Only the M7 model supports this parameter. + choices: [0, 1, 2, 3] + type: int + start1: + description: + - Pause period of add, start time, from 0 to 24. + type: int + end1: + description: + - Pause period of add, end time, must be greater than start time, from 0 to 24. + type: int + week1: + description: + - Pause period of add, repetition period. + - The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri. + type: list + elements: str + start2: + description: + - Pause period of add, start time, from 0 to 24. + type: int + end2: + description: + - Pause period of add, end time, must be greater than start time, from 0 to 24. + type: int + week2: + description: + - Pause period of add, repetition period. + - The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri. + type: list + elements: str + start3: + description: + - Pause period of add, start time, from 0 to 24. + type: int + end3: + description: + - Pause period of add, end time, must be greater than start time, from 0 to 24. + type: int + week3: + description: + - Pause period of add, repetition period. + - The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri. + type: list + elements: str + start4: + description: + - Pause period of add, start time, from 0 to 24. + type: int + end4: + description: + - Pause period of add, end time, must be greater than start time, from 0 to 24. + type: int + week4: + description: + - Pause period of add, repetition period. + - The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri. + type: list + elements: str + start5: + description: + - Period of add, start time, from 0 to 24. + type: int + end5: + description: + - Pause period of add, end time, must be greater than start time, from 0 to 24. + type: int + week5: + description: + - Pause period of add, repetition period. + - The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri. + type: list + elements: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power budget test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power budget range" + ieisystem.inmanage.edit_power_budget: + range: True + provider: "{{ inmanage }}" + + - name: "add power budget" + ieisystem.inmanage.edit_power_budget: + action: "add" + id: 1 + watts: 1500 + start1: 2 + end1: 5 + week1: + - Mon + - Wed + - Fri + provider: "{{ inmanage }}" + + - name: "Set power budget status to open" + ieisystem.inmanage.edit_power_budget: + action: "open" + id: 1 + provider: "{{ inmanage }}" + + - name: "Set power budget status to close" + ieisystem.inmanage.edit_power_budget: + action: "close" + id: 1 + provider: "{{ inmanage }}" + + - name: "Delete power budget" + ieisystem.inmanage.edit_power_budget: + action: "delete" + id: 1 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setpowerbudget' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + range=dict(type='bool', default=False, choices=[True, False]), + domain=dict(type='str', required=False, choices=['system', 'cpu']), + action=dict(type='str', required=False, choices=['add', 'delete', 'open', 'close']), + id=dict(type='int', required=False, choices=[1, 2, 3, 4]), + watts=dict(type='int', required=False), + except_action=dict(type='int', required=False, choices=[0, 1, 2, 3]), + start1=dict(type='int', required=False), + end1=dict(type='int', required=False), + week1=dict(type='list', elements='str', required=False), + start2=dict(type='int', required=False), + end2=dict(type='int', required=False), + week2=dict(type='list', elements='str', required=False), + start3=dict(type='int', required=False), + end3=dict(type='int', required=False), + week3=dict(type='list', elements='str', required=False), + start4=dict(type='int', required=False), + end4=dict(type='int', required=False), + week4=dict(type='list', elements='str', required=False), + start5=dict(type='int', required=False), + end5=dict(type='int', required=False), + week5=dict(type='list', elements='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_restore.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_restore.py new file mode 100644 index 000000000..e344b4686 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_restore.py @@ -0,0 +1,110 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_power_restore +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set power restore information +description: + - Set power restore information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + option: + description: + - Set power policy option. + choices: ['on', 'off', 'restore'] + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power restore test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set power restore information" + ieisystem.inmanage.edit_power_restore: + option: "on" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setpowerrestore' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + option=dict(type='str', required=True, choices=['on', 'off', 'restore']), + ) + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_status.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_status.py new file mode 100644 index 000000000..4aef12e72 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_power_status.py @@ -0,0 +1,110 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_power_status +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set power status information +description: + - Set power status information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + state: + description: + - Power status. + choices: ['On', 'ForceOff', 'ForcePowerCycle', 'ForceReset', 'GracefulShutdown'] + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power status test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set power status information" + ieisystem.inmanage.edit_power_status: + state: "On" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'powercontrol' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + state=dict(type='str', required=True, choices=['On', 'ForceOff', 'ForcePowerCycle', 'ForceReset', 'GracefulShutdown']), + ) + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_preserve_config.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_preserve_config.py new file mode 100644 index 000000000..e40d561de --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_preserve_config.py @@ -0,0 +1,136 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_preserve_config +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set preserve config +description: + - Set preserve config on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + setting: + description: + - Preserve option, all - preserve all config; none - overwrite all config; manual - manual choose. + choices: ['all', 'none', 'manual'] + type: str + required: true + override: + description: + - Configuration items that need to be retained. + - Required when I(setting=manual). + choices: ['authentication', 'dcmi', 'fru', 'hostname', 'ipmi', 'kvm', 'network', 'ntp', 'pef', + 'sdr', 'sel', 'smtp', 'snmp', 'sol', 'ssh', 'syslog', 'user'] + type: list + elements: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Preserve test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set preserve all" + ieisystem.inmanage.edit_preserve_config: + setting: "all" + provider: "{{ inmanage }}" + + - name: "Set preserve none" + edit_preserve_config: + setting: "none" + provider: "{{ inmanage }}" + + - name: "Set preserve manual" + edit_preserve_config: + setting: "manual" + override: + - fru + - ntp + - network + - user + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Preserve(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'preserveconfig' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + setting=dict(type='str', required=True, choices=['all', 'none', 'manual']), + override=dict(type='list', elements='str', required=False, + choices=['authentication', 'dcmi', 'fru', 'hostname', 'ipmi', 'kvm', 'network', 'ntp', + 'pef', 'sdr', 'sel', 'smtp', 'snmp', 'sol', 'ssh', 'syslog', 'user']), + ) + argument_spec.update(inmanage_argument_spec) + pre_obj = Preserve(argument_spec) + pre_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_psu_config.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_psu_config.py new file mode 100644 index 000000000..7e85f9293 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_psu_config.py @@ -0,0 +1,116 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_psu_config +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set psu config information +description: + - Set psu config information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + id: + description: + - Power id. + type: int + required: true + switch: + description: + - Power supply mode, active or standby. + choices: ['active', 'standby', 'normal'] + type: str + required: true +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Psu config test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set psu config information" + ieisystem.inmanage.edit_psu_config: + id: 1 + switch: "active" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Psu(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setpsuconfig' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + id=dict(type='int', required=True), + switch=dict(type='str', required=True, choices=['active', 'standby', 'normal']), + ) + argument_spec.update(inmanage_argument_spec) + psu_obj = Psu(argument_spec) + psu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_psu_peak.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_psu_peak.py new file mode 100644 index 000000000..6bb15a6d9 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_psu_peak.py @@ -0,0 +1,121 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_psu_peak +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set psu peak information +description: + - Set psu peak information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + status: + description: + - Power peak status. + choices: ['enable', 'disable'] + type: str + required: true + time: + description: + - Maximum random time, range of values(1-600), unit(second). + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Psu peak test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set psu peak information" + ieisystem.inmanage.edit_psu_peak: + status: "disable" + provider: "{{ inmanage }}" + + - name: "Set psu peak information" + ieisystem.inmanage.edit_psu_peak: + status: "enable" + time: 10 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Psu(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setpsupeak' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + status=dict(type='str', required=True, choices=['enable', 'disable']), + time=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + psu_obj = Psu(argument_spec) + psu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_restore_factory_default.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_restore_factory_default.py new file mode 100644 index 000000000..8f1c3d599 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_restore_factory_default.py @@ -0,0 +1,131 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_restore_factory_default +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set preserver config +description: + - Set preserver config on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + mode: + description: + - Restore factory defaults mode. + choices: ['all', 'none', 'manual'] + type: str + required: true + override: + description: + - Configuration items that need to be retained. + - Required when I(mode=manual). + choices: ['authentication', 'dcmi', 'fru', 'hostname', 'ipmi', 'kvm', 'network', 'ntp', 'pef', + 'sdr', 'sel', 'smtp', 'snmp', 'sol', 'ssh', 'syslog', 'user'] + type: list + elements: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Restore default test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set restore default auto" + ieisystem.inmanage.edit_restore_factory_default: + mode: "all" + provider: "{{ inmanage }}" + + - name: "Set restore default manual" + ieisystem.inmanage.edit_restore_factory_default: + mode: "manual" + override: + - fru + - ntp + - network + - user + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Preserver(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'restorefactorydefaults' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + mode=dict(type='str', required=True, choices=['all', 'none', 'manual']), + override=dict(type='list', elements='str', required=False, + choices=['authentication', 'dcmi', 'fru', 'hostname', 'ipmi', 'kvm', 'network', 'ntp', + 'pef', 'sdr', 'sel', 'smtp', 'snmp', 'sol', 'ssh', 'syslog', 'user']), + ) + argument_spec.update(inmanage_argument_spec) + pre_obj = Preserver(argument_spec) + pre_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_service.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_service.py new file mode 100644 index 000000000..0fbd55a38 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_service.py @@ -0,0 +1,150 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_service +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set service settings +description: + - Set service settings on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + service_name: + description: + - Displays service name of the selected slot(readonly). + - The I(vnc) option is not supported in M5. + - The I(fd-media/telnet/snmp) option is not supported in M6. + choices: ['web', 'kvm', 'cd-media', 'fd-media', 'hd-media', 'ssh', 'telnet', 'solssh', 'snmp', 'vnc'] + type: str + required: true + state: + description: + - Displays the current status of the service, either active or inactive state. + - Check this option to start the inactive service. + choices: ['active', 'inactive'] + type: str + interface: + description: + - It shows the interface in which service is running. + - The user can choose any one of the available interfaces. + - Only the M5 model supports this parameter. + choices: ['eth0', 'eth1', 'both', 'bond0'] + type: str + non_secure_port: + description: + - Used to configure non secure port number for the service. + - Port value ranges from 1 to 65535. + type: int + secure_port: + description: + - Used to configure secure port number for the service. + - Port value ranges from 1 to 65535. + type: int + timeout: + description: + - Displays the session timeout value of the service. + - For web, SSH and telnet service, user can configure the session timeout value. + - Web timeout value ranges from 300 to 1800 seconds. + - SSH and Telnet timeout value ranges from 60 to 1800 seconds. + - Timeout value should be in multiples of 60 seconds. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Edit service test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit kvm" + ieisystem.inmanage.edit_service: + service_name: "kvm" + state: "active" + timeout: "1200" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Service(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setservice' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + service_name=dict(type='str', required=True, choices=['web', 'kvm', 'cd-media', 'fd-media', 'hd-media', 'ssh', 'telnet', 'solssh', 'snmp', 'vnc']), + state=dict(type='str', required=False, choices=['active', 'inactive']), + interface=dict(type='str', required=False, choices=['eth0', 'eth1', 'both', 'bond0']), + non_secure_port=dict(type='int', required=False), + secure_port=dict(type='int', required=False), + timeout=dict(type='int', required=False) + ) + argument_spec.update(inmanage_argument_spec) + service_obj = Service(argument_spec) + service_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp.py new file mode 100644 index 000000000..c59a3cc66 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp.py @@ -0,0 +1,213 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_smtp +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set SMTP information +description: + - Set SMTP information on ieisystem Server. + - Only the M5 models support this feature. +notes: + - Does not support C(check_mode). +options: + interface: + description: + - LAN Channel, eth0 is shared, eth1 is dedicated. + choices: ['eth0', 'eth1', 'bond0'] + type: str + required: true + email: + description: + - Sender email. + type: str + primary_status: + description: + - Primary SMTP Support. + choices: ['enable', 'disable'] + type: str + primary_ip: + description: + - Primary SMTP server IP. + type: str + primary_name: + description: + - Primary SMTP server name. + type: str + primary_port: + description: + - Primary SMTP server port, The Identification for retry count configuration(1-65535). + type: int + primary_auth: + description: + - Primary SMTP server authentication. + choices: ['enable', 'disable'] + type: str + primary_username: + description: + - Primary SMTP server Username, length be 4 to 64 bits. + - Must start with letters and cannot contain ', '(comma) ':'(colon) ' '(space) ';'(semicolon) '\\'(backslash). + type: str + primary_password: + description: + - Primary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space). + - Required when I(primary_auth=enable). + type: str + secondary_status: + description: + - Secondary SMTP Support. + choices: ['enable', 'disable'] + type: str + secondary_ip: + description: + - Secondary SMTP server IP. + type: str + secondary_name: + description: + - Secondary SMTP server name. + type: str + secondary_port: + description: + - Secondary SMTP server port, The Identification for retry count configuration(1-65535). + type: int + secondary_auth: + description: + - Secondary SMTP server authentication. + choices: ['enable', 'disable'] + type: str + secondary_username: + description: + - Secondary SMTP server Username, length be 4 to 64 bits. + - Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\\'(backslash). + type: str + secondary_password: + description: + - Secondary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space). + - Required when I(secondary_auth=enable). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Smtp test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp information" + ieisystem.inmanage.edit_smtp: + interface: "eth0" + email: "ieit@ieisystem.com" + primary_status: "enable" + primary_ip: "100.2.2.2" + primary_name: "test" + primary_auth: "disable" + provider: "{{ inmanage }}" + + - name: "Set smtp information" + ieisystem.inmanage.edit_smtp: + interface: "eth0" + email: "ieit@ieisystem.com" + primary_status: "enable" + primary_ip: "100.2.2.2" + primary_name: "test" + primary_auth: "enable" + primary_username: "test" + primary_password: my_password + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SMTP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setsmtp' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + interface=dict(type='str', required=True, choices=['eth0', 'eth1', 'bond0']), + email=dict(type='str', required=False), + primary_status=dict(type='str', required=False, choices=['enable', 'disable']), + primary_ip=dict(type='str', required=False), + primary_name=dict(type='str', required=False), + primary_port=dict(type='int', required=False), + primary_auth=dict(type='str', required=False, choices=['enable', 'disable']), + primary_username=dict(type='str', required=False), + primary_password=dict(type='str', required=False, no_log=True), + secondary_status=dict(type='str', required=False, choices=['enable', 'disable']), + secondary_ip=dict(type='str', required=False), + secondary_name=dict(type='str', required=False), + secondary_port=dict(type='int', required=False), + secondary_auth=dict(type='str', required=False, choices=['enable', 'disable']), + secondary_username=dict(type='str', required=False), + secondary_password=dict(type='str', required=False, no_log=True), + + ) + argument_spec.update(inmanage_argument_spec) + smtp_obj = SMTP(argument_spec) + smtp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp_com.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp_com.py new file mode 100644 index 000000000..7e2618715 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp_com.py @@ -0,0 +1,204 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_smtp_com +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set SMTP information +description: + - Set SMTP com information on ieisystem Server. + - Only the M6 models support this feature. +notes: + - Does not support C(check_mode). +options: + status: + description: + - SMTP Support. + choices: ['enable', 'disable'] + required: true + type: str + server_ip: + description: + - SMTP server IP. + type: str + server_port: + description: + - SMTP server port, The Identification for retry count configuration(1-65535). + type: int + server_secure_port: + description: + - SMTP server secure port, The Identification for retry count configuration(1-65535). + type: int + email: + description: + - Sender email. + type: str + server_auth: + description: + - SMTP server authentication. + choices: ['enable', 'disable'] + type: str + server_username: + description: + - SMTP server Username, length be 4 to 64 bits. + - Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\\'(backslash). + - Required when I(server_auth=enable). + type: str + server_password: + description: + - SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space). + - Required when I(server_auth=enable). + type: str + ssl_tls_enable: + description: + - SMTP SSLTLS Enable. + - I(ssl_tls_enable=disable), when I(star_tls_enable=enable). + choices: ['enable', 'disable'] + type: str + star_tls_enable: + description: + - SMTP STARTTLS Enable. + - I(star_tls_enable=disable), when I(ssl_tls_enable=enable). + choices: ['enable', 'disable'] + type: str + subject: + description: + - Email theme. + type: str + host_name: + description: + - Server name. + choices: ['enable', 'disable'] + type: str + serial_number: + description: + - Serial number. + choices: ['enable', 'disable'] + type: str + asset_tag: + description: + - Product asset label. + choices: ['enable', 'disable'] + type: str + event_level: + description: + - Events above this level will be sent. + choices: ['Info', 'Warning', 'Critical'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Smtp com test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp com information" + ieisystem.inmanage.edit_smtp_com: + status: "disable" + provider: "{{ inmanage }}" + + - name: "Set smtp com information" + ieisystem.inmanage.edit_smtp_com: + status: "enable" + server_ip: "100.2.2.2" + email: "ieit@ieisystem.com" + server_auth: "enable" + server_username: "admin" + server_password: "1234qwer!@#$" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SMTP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setsmtpcom' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + status=dict(type='str', required=True, choices=['enable', 'disable']), + server_ip=dict(type='str', required=False), + server_port=dict(type='int', required=False), + server_secure_port=dict(type='int', required=False), + email=dict(type='str', required=False), + server_auth=dict(type='str', required=False, choices=['enable', 'disable']), + server_username=dict(type='str', required=False), + server_password=dict(type='str', required=False, no_log=True), + ssl_tls_enable=dict(type='str', required=False, choices=['enable', 'disable']), + star_tls_enable=dict(type='str', required=False, choices=['enable', 'disable']), + subject=dict(type='str', required=False), + host_name=dict(type='str', required=False, choices=['enable', 'disable']), + serial_number=dict(type='str', required=False, choices=['enable', 'disable']), + asset_tag=dict(type='str', required=False, choices=['enable', 'disable']), + event_level=dict(type='str', required=False, choices=['Info', 'Warning', 'Critical']), + ) + argument_spec.update(inmanage_argument_spec) + smtp_obj = SMTP(argument_spec) + smtp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp_dest.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp_dest.py new file mode 100644 index 000000000..2d8d6a6d3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_smtp_dest.py @@ -0,0 +1,136 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_smtp_dest +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set SMTP information +description: + - Set SMTP dest information on ieisystem Server. + - Only the M6 models support this feature. +notes: + - Does not support C(check_mode). +options: + id: + description: + - Email destination id. + choices: [1, 2, 3, 4] + type: int + required: true + status: + description: + - Email enable. + choices: ['enable', 'disable'] + type: str + address: + description: + - Email address. + type: str + description: + description: + - Description information. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Smtp dest test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp dest information" + ieisystem.inmanage.edit_smtp_dest: + id: 1 + status: "disable" + provider: "{{ inmanage }}" + + - name: "Set smtp dest information" + ieisystem.inmanage.edit_smtp_dest: + id: 1 + status: "enable" + address: "100.2.2.2" + description": "test" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SMTP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setsmtpdest' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + id=dict(type='int', required=True, choices=[1, 2, 3, 4]), + status=dict(type='str', required=False, choices=['enable', 'disable']), + address=dict(type='str', required=False), + description=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + smtp_obj = SMTP(argument_spec) + smtp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_snmp.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_snmp.py new file mode 100644 index 000000000..52ccedb2e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_snmp.py @@ -0,0 +1,188 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_snmp +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set snmp +description: + - Set snmp on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + version: + description: + - SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'. + - Only the M5 models support this feature. + choices: [0, 1, 2, 3, 4] + type: int + snmp_status: + description: + - NMP read/write status of customize. + - The input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set', separated by commas, such as v1get, v1set, v2cget. + - Only the M5 models support this feature. + type: list + elements: str + community: + description: + - Community of v1/v2c or v1get/v1set/v2cget/v2cset. + - Only the M5 models support this feature. + type: str + v1status: + description: + - SNMP V1 enable. + choices: ['enable', 'disable'] + type: str + v2status: + description: + - SNMP V2 enable. + choices: ['enable', 'disable'] + type: str + v3status: + description: + - SNMP V3 enable. + choices: ['enable', 'disable'] + type: str + read_community: + description: + - Read Only Community, Community should between 1 and 16 characters. + - Only the M6 models support this feature. + type: str + read_write_community: + description: + - Read And Write Community, Community should between 1 and 16 characters. + - Only the M6 models support this feature. + type: str + v3username: + description: + - Set a username for the V3 trap or v3get/v3set. + type: str + auth_protocol: + description: + - Choose the authentication protocol for the V3 trap or v3get/v3set. + choices: ['NONE', 'SHA', 'MD5'] + type: str + auth_password: + description: + - Set the authentication password for the V3 trap or v3get/v3set. + - The password is a string of 8 to 16 alphanumeric characters. + - Required when I(auth_protocol) is either C(SHA) or C(MD5). + type: str + priv_protocol: + description: + - Choose the privacy protocol for the V3 trap or v3get/v3set. + choices: ['NONE', 'DES', 'AES'] + type: str + priv_password: + description: + - Set the privacy password for the V3 trap or v3get/v3set. + - The password is a string of 8 to 16 alphanumeric characters. + - Required when I(priv_protocol) is either C(DES) or C(AES). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Snmp test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set snmp get/set" + ieisystem.inmanage.edit_snmp: + community: "test" + v3username: "test" + provider: "{{ inmanage }}" + +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SNMP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setsnmp' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + version=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]), + snmp_status=dict(type='list', elements='str', required=False), + community=dict(type='str', required=False), + v1status=dict(type='str', required=False, choices=['enable', 'disable']), + v2status=dict(type='str', required=False, choices=['enable', 'disable']), + v3status=dict(type='str', required=False, choices=['enable', 'disable']), + read_community=dict(type='str', required=False), + read_write_community=dict(type='str', required=False), + v3username=dict(type='str', required=False), + auth_protocol=dict(type='str', required=False, choices=['NONE', 'SHA', 'MD5']), + auth_password=dict(type='str', required=False, no_log=True), + priv_protocol=dict(type='str', required=False, choices=['NONE', 'DES', 'AES']), + priv_password=dict(type='str', required=False, no_log=True), + ) + argument_spec.update(inmanage_argument_spec) + snmp_obj = SNMP(argument_spec) + snmp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_snmp_trap.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_snmp_trap.py new file mode 100644 index 000000000..a48771d34 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_snmp_trap.py @@ -0,0 +1,217 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_snmp_trap +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set snmp trap +description: + - Set snmp trap on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + version: + description: + - SNMP trap version, 1 is v1, 2 is v2c(v2), 3 is v3, 0 is disable snmp trap. + - Only the M6 model supports C(0) Settings. + choices: [0, 1, 2, 3] + type: int + event_severity: + description: + - Event Severity. + choices: ['all', 'warning', 'critical'] + type: str + community: + description: + - Community of v1/v2c. + type: str + host_id: + description: + - Host id. + - Only the M6 model supports this parameter. + choices: ['HostName', 'SerialNum', 'AssertTag'] + type: str + v3username: + description: + - Set the username for the V3 trap. + type: str + engine_id: + description: + - Specifies an engine identifier for the V3 trap. The value should be string of 10 to 48 hex characters, must be even, can be NULL. + type: str + auth_protocol: + description: + - Choose the authentication protocol for the V3 trap. + choices: ['NONE', 'SHA', 'MD5'] + type: str + auth_password: + description: + - Set the authentication password for the V3 trap. + - The password is a string of 8 to 16 alphanumeric characters. + - Required when I(auth_protocol) is either C(SHA) or C(MD5). + type: str + priv_protocol: + description: + - Choose the privacy protocol for the V3 trap. + choices: ['NONE', 'DES', 'AES'] + type: str + priv_password: + description: + - Set the privacy password for the V3 trap. + - The password is a string of 8 to 16 alphanumeric characters. + - Required when I(priv_protocol) is either C(DES) or C(AES). + type: str + system_name: + description: + - Set the system name, can be NULL. + - Only the M5 model supports this parameter. + type: str + system_id: + description: + - Set the system ID, can be NULL. + - Only the M5 model supports this parameter. + type: str + location: + description: + - Set the host location, can be NULL. + - Only the M5 model supports this parameter. + type: str + contact: + description: + - Set the contact, can be NULL. + - Only the M5 model supports this parameter. + type: str + os: + description: + - Set the host operating system, can be NULL. + - Only the M5 model supports this parameter. + type: str + trap_port: + description: + - Set a port for the SNMP trap in the range of 1 to 65535. + - Only the M5 model supports this parameter. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Trap test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set snmp trap v2c" + ieisystem.inmanage.edit_snmp_trap: + version: 2 + event_severity: "warning" + community: "test" + system_name: "ieisystem" + provider: "{{ inmanage }}" + + - name: "Set snmp trap v3" + ieisystem.inmanage.edit_snmp_trap: + version: 3 + event_severity: "all" + v3username: "ieisystem" + engine_id: "1234567890" + auth_protocol: "SHA" + auth_password: "12345678" + priv_protocol: "AES" + priv_password: "123454678" + trap_port: 162 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SNMP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setsnmptrap' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + version=dict(type='int', required=False, choices=[0, 1, 2, 3]), + event_severity=dict(type='str', required=False, choices=['all', 'warning', 'critical']), + community=dict(type='str', required=False), + host_id=dict(type='str', required=False, choices=['HostName', 'SerialNum', 'AssertTag']), + v3username=dict(type='str', required=False), + engine_id=dict(type='str', required=False), + auth_protocol=dict(type='str', required=False, choices=['NONE', 'SHA', 'MD5']), + auth_password=dict(type='str', required=False, no_log=True), + priv_protocol=dict(type='str', required=False, choices=['NONE', 'DES', 'AES']), + priv_password=dict(type='str', required=False, no_log=True), + system_name=dict(type='str', required=False), + system_id=dict(type='str', required=False), + location=dict(type='str', required=False), + contact=dict(type='str', required=False), + os=dict(type='str', required=False), + trap_port=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + snmp_obj = SNMP(argument_spec) + snmp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_threshold.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_threshold.py new file mode 100644 index 000000000..8b12b59cb --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_threshold.py @@ -0,0 +1,141 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_threshold +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set threshold information +description: + - Set threshold information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + name: + description: + - Sensor name. + type: str + required: true + lnr: + description: + - Lower non recoverable threshold, should be integer. + type: int + lc: + description: + - Lower critical threshold, should be integer. + type: int + lnc: + description: + - Lower non critical threshold, should be integer. + type: int + unc: + description: + - Up non critical threshold, should be integer. + type: int + uc: + description: + - Up critical threshold, should be integer. + type: int + unr: + description: + - Up non recoverable threshold, should be integer. + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Threshold test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set threshold information" + ieisystem.inmanage.edit_threshold: + name: "GPU1_Temp" + uc: 94 + unc: 92 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Threshold(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setthreshold' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + name=dict(type='str', required=True), + lnr=dict(type='int', required=False), + lc=dict(type='int', required=False), + lnc=dict(type='int', required=False), + unc=dict(type='int', required=False), + uc=dict(type='int', required=False), + unr=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + threshoold_obj = Threshold(argument_spec) + threshoold_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_uid.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_uid.py new file mode 100644 index 000000000..8dc5a0f17 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_uid.py @@ -0,0 +1,121 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_uid +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set UID +description: + - Set UID on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + led: + description: + - Turn on or turn off the led. + choices: ['on', 'off'] + type: str + required: true + time: + description: + - Set led blink time(second). + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: UID test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set uid" + ieisystem.inmanage.edit_uid: + led: "on" + time: 10 + provider: "{{ inmanage }}" + + - name: "Set uid" + ieisystem.inmanage.edit_uid: + led: "off" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class UID(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setuid' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + led=dict(type='str', required=True, choices=['on', 'off']), + time=dict(type='int', required=False), + ) + argument_spec.update(inmanage_argument_spec) + uid_obj = UID(argument_spec) + uid_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_virtual_media.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_virtual_media.py new file mode 100644 index 000000000..8a7a60da3 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_virtual_media.py @@ -0,0 +1,182 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_virtual_media +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set virtual media +description: + - Set virtual media on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + local_media_support: + description: + - To enable or disable Local Media Support, check or uncheck the checkbox respectively. + - Only the M5 model supports this parameter. + choices: ['Enable', 'Disable'] + type: str + remote_media_support: + description: + - To enable or disable Remote Media support, check or uncheck the checkbox respectively. + choices: ['Enable', 'Disable'] + type: str + mount_type: + description: + - Virtual mount type. + - The I(FD) option is not supported in M6. + choices: ['CD', 'FD', 'HD'] + type: str + same_settings: + description: + - Same settings with I(CD), 0 is No, 1 is Yes. + - Required when I(mount_type=0). + choices: [0, 1] + type: int + mount: + description: + - Whether to mount virtual media. + - Only the M5 model supports this parameter. + choices: ['Enable', 'Disable'] + type: str + remote_server_address: + description: + - Address of the server where the remote media images are stored. + type: str + remote_source_path: + description: + - Source path to the remote media images.. + type: str + remote_share_type: + description: + - Share Type of the remote media server either NFS or Samba(CIFS). + choices: ['nfs', 'cifs'] + type: str + remote_domain_name: + description: + - Remote Domain Name, Domain Name field is optional. + type: str + remote_user_name: + description: + - Remote User Name. + - Required when I(remote_share_type=cifs). + type: str + remote_password: + description: + - Remote Password. + - Required when I(remote_share_type=cifs). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Media test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set local media" + ieisystem.inmanage.edit_virtual_media: + local_media_support: "Enable" + provider: "{{ inmanage }}" + + - name: "Set remote media" + ieisystem.inmanage.edit_virtual_media: + remote_media_support: "Enable" + mount_type: 'CD' + same_settings: 0 + mount: "Enable" + remote_server_address: "100.2.28.203" + remote_source_path: "/data/nfs/server/" + remote_share_type: "nfs" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Media(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setvirtualmedia' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + local_media_support=dict(type='str', required=False, choices=['Enable', 'Disable']), + remote_media_support=dict(type='str', required=False, choices=['Enable', 'Disable']), + mount_type=dict(type='str', required=False, choices=['CD', 'FD', 'HD']), + same_settings=dict(type='int', required=False, choices=[0, 1]), + mount=dict(type='str', required=False, choices=['Enable', 'Disable']), + remote_server_address=dict(type='str', required=False), + remote_source_path=dict(type='str', required=False), + remote_share_type=dict(type='str', required=False, choices=['nfs', 'cifs']), + remote_domain_name=dict(type='str', required=False), + remote_user_name=dict(type='str', required=False), + remote_password=dict(type='str', required=False, no_log=True), + ) + argument_spec.update(inmanage_argument_spec) + media_obj = Media(argument_spec) + media_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/edit_vlan.py b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_vlan.py new file mode 100644 index 000000000..be020d8df --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/edit_vlan.py @@ -0,0 +1,136 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: edit_vlan +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Set vlan information +description: + - Set vlan information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + interface_name: + description: + - Set interface name. Select the LAN interface to be configured. + choices: ['eth0', 'eth1', 'bond0'] + required: true + type: str + vlan_status: + description: + - Enable or disable vlan. + choices: ['enable', 'disable'] + type: str + vlan_id: + description: + - The Identification for VLAN configuration(2-4094). + type: int + vlan_priority: + description: + - The priority for VLAN configuration(1-7). + type: int +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Vlan test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set vlan information" + ieisystem.inmanage.edit_vlan: + interface_name: "eth0" + vlan_status: "disable" + provider: "{{ inmanage }}" + + - name: "Set vlan information" + ieisystem.inmanage.edit_vlan: + interface_name: "eth0" + vlan_status: "enable" + vlan_id: 2 + vlan_priority: 1 + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Network(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'setvlan' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + interface_name=dict(type='str', required=True, choices=['eth0', 'eth1', 'bond0']), + vlan_status=dict(type='str', required=False, choices=['enable', 'disable']), + vlan_id=dict(type='int', required=False), + vlan_priority=dict(type='int', required=False), + + ) + argument_spec.update(inmanage_argument_spec) + net_obj = Network(argument_spec) + net_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/event_log_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/event_log_info.py new file mode 100644 index 000000000..0d35dd002 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/event_log_info.py @@ -0,0 +1,126 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: event_log_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get event log information +description: + - Get event log information on ieisystem Server. +notes: + - Supports C(check_mode). +options: + log_time: + description: + - Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00. + type: str + count: + description: + - Get the most recent log of a specified number. + type: int + event_file: + description: + - Store logs to a file. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Event log info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get event log information" + ieisystem.inmanage.event_log_info: + log_time: "2020-06-01T12:30+08:00" + provider: "{{ inmanage }}" + + - name: "Get event log information" + ieisystem.inmanage.event_log_info: + count: 30 + provider: "{{ inmanage }}" + + - name: "Get event log information" + ieisystem.inmanage.event_log_info: + event_file: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class EventLog(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'geteventlog' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + log_time=dict(type='str', required=False), + count=dict(type='int', required=False), + event_file=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = EventLog(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/event_log_policy_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/event_log_policy_info.py new file mode 100644 index 000000000..0dca1a8fd --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/event_log_policy_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: event_log_policy_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get event log policy information +description: + - Get event log policy information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Event log policy test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get event log policy information" + ieisystem.inmanage.event_log_policy_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Log(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'geteventlogpolicy' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + log_obj = Log(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/fan_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/fan_info.py new file mode 100644 index 000000000..fca0b7efd --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/fan_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: fan_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get fan information +description: + - Get fan information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Fan test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get fan information" + ieisystem.inmanage.fan_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Fan(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getfan' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + fan_obj = Fan(argument_spec) + fan_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/fru_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/fru_info.py new file mode 100644 index 000000000..b42441f79 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/fru_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: fru_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get fru information +description: + - Get fru information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Fru info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get fru information" + ieisystem.inmanage.fru_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Fru(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getfru' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + fru_obj = Fru(argument_spec) + fru_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/fw_version_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/fw_version_info.py new file mode 100644 index 000000000..03c71e666 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/fw_version_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: fw_version_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get firmware version information +description: + - Get firmware version information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Firmware version test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get firmware version information" + ieisystem.inmanage.fw_version_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class FwVersion(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getfw' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + fw_obj = FwVersion(argument_spec) + fw_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/gpu_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/gpu_info.py new file mode 100644 index 000000000..bfa16da19 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/gpu_info.py @@ -0,0 +1,100 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: gpu_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get GPU information +description: + - Get GPU information on ieisystem Server. + - Only the M6 models support this feature. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: GPU test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get gpu information" + ieisystem.inmanage.gpu_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class CPU(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getgpu' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + cpu_obj = CPU(argument_spec) + cpu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/hard_disk_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/hard_disk_info.py new file mode 100644 index 000000000..e0c994319 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/hard_disk_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: hard_disk_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get hard disk information +description: + - Get hard disk information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Hard disk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get hard disk information" + ieisystem.inmanage.hard_disk_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Harddisk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getharddisk' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + disk_obj = Harddisk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/hba_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/hba_info.py new file mode 100644 index 000000000..0fd115a60 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/hba_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: hba_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get CPU information +description: + - Get HBA information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: HBA test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get hba information" + ieisystem.inmanage.hba_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class HBA(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'gethba' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + hba_obj = HBA(argument_spec) + hba_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/kvm_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/kvm_info.py new file mode 100644 index 000000000..d101c1f40 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/kvm_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: kvm_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get KVM information +description: + - Get KVM information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: KVM test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get KVM information" + ieisystem.inmanage.kvm_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class KVM(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getkvm' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + kvm_obj = KVM(argument_spec) + kvm_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_group.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_group.py new file mode 100644 index 000000000..d561a3521 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_group.py @@ -0,0 +1,158 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ldap_group +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Manage ldap group information +description: + - Manage ldap group information on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + state: + description: + - Whether the ldap group should exist or not, taking action if the state is different from what is stated. + choices: ['present', 'absent'] + default: present + type: str + name: + description: + - Group name. + type: str + required: true + base: + description: + - Search Base. + type: str + pri: + description: + - Group privilege. + choices: ['administrator', 'user', 'operator', 'oem', 'none'] + type: str + kvm: + description: + - Kvm privilege. + choices: ['enable', 'disable'] + type: str + vm: + description: + - Vmedia privilege. + choices: ['enable', 'disable'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ldap group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add ldap group information" + ieisystem.inmanage.ldap_group: + state: "present" + name: "wbs" + base: "cn=manager" + pri: "administrator" + kvm: "enable" + vm: "disable" + provider: "{{ inmanage }}" + + - name: "Set ldap group information" + ieisystem.inmanage.ldap_group: + state: "present" + name: "wbs" + pri: "user" + kvm: "disable" + provider: "{{ inmanage }}" + + - name: "Delete ldap group information" + ieisystem.inmanage.ldap_group: + state: "absent" + name: "wbs" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LDAP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'editldapgroup' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + state=dict(type='str', choices=['present', 'absent'], default='present'), + name=dict(type='str', required=True), + base=dict(type='str', required=False), + pri=dict(type='str', required=False, choices=['administrator', 'user', 'operator', 'oem', 'none']), + kvm=dict(type='str', required=False, choices=['enable', 'disable']), + vm=dict(type='str', required=False, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + ldap_obj = LDAP(argument_spec) + ldap_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_group_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_group_info.py new file mode 100644 index 000000000..13d0379cf --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_group_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ldap_group_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get ldap group information +description: + - Get ldap group information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ldap group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ldap group information" + ieisystem.inmanage.ldap_group_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LDAP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getldapgroup' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + ldap_obj = LDAP(argument_spec) + ldap_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_info.py new file mode 100644 index 000000000..9cf87bb9b --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ldap_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ldap_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get ldap information +description: + - Get ldap information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ldap test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ldap information" + ieisystem.inmanage.ldap_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LDAP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getldap' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + ldap_obj = LDAP(argument_spec) + ldap_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ldisk_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ldisk_info.py new file mode 100644 index 000000000..f41926543 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ldisk_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ldisk_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get logical disks information +description: + - Get logical disks information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Ldisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get logical disks information" + ieisystem.inmanage.ldisk_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Disk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getldisk' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + disk_obj = Disk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/log_setting_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/log_setting_info.py new file mode 100644 index 000000000..fce21d462 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/log_setting_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: log_setting_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get bmc log setting information +description: + - Get bmc log setting information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bmc log setting test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc log setting information" + ieisystem.inmanage.log_setting_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class LogSetting(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getbmclogsettings' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + cpu_obj = LogSetting(argument_spec) + cpu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/media_instance_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/media_instance_info.py new file mode 100644 index 000000000..d106f2603 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/media_instance_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: media_instance_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get Virtual Media Instance information +description: + - Get Virtual Media Instance information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Media instance test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get Virtual Media Instance information" + ieisystem.inmanage.media_instance_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Instance(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getmediainstance' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + instance_obj = Instance(argument_spec) + instance_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/mem_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/mem_info.py new file mode 100644 index 000000000..d58ad90f7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/mem_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: mem_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get memory information +description: + - Get memory information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Memory test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get memory information" + ieisystem.inmanage.mem_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Memory(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getmemory' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + mem_obj = Memory(argument_spec) + mem_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ncsi_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ncsi_info.py new file mode 100644 index 000000000..4636a2236 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ncsi_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ncsi_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get ncsi information +description: + - Get ncsi information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: NCSI test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ncsi information" + ieisystem.inmanage.ncsi_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class NCSI(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getncsi' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + ncsi_obj = NCSI(argument_spec) + ncsi_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/network_bond_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/network_bond_info.py new file mode 100644 index 000000000..96c48143c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/network_bond_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: network_bond_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get network bond information +description: + - Get network bond information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bond test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network bond information" + ieisystem.inmanage.network_bond_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Bond(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getnetworkbond' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + bond_obj = Bond(argument_spec) + bond_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/network_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/network_info.py new file mode 100644 index 000000000..55feae870 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/network_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: network_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get network information +description: + - Get network information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Network test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network information" + ieisystem.inmanage.network_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Network(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getnetwork' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + net_obj = Network(argument_spec) + net_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/network_link_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/network_link_info.py new file mode 100644 index 000000000..01e11f2f7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/network_link_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: network_link_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get network link information +description: + - Get network link information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Link test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network link information" + ieisystem.inmanage.network_link_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Link(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getnetworklink' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + link_obj = Link(argument_spec) + link_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/ntp_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/ntp_info.py new file mode 100644 index 000000000..782012f04 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/ntp_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: ntp_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get NTP information +description: + - Get NTP information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: NTP test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ntp information" + ieisystem.inmanage.ntp_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class NTP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'gettime' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + ntp_obj = NTP(argument_spec) + ntp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/onboard_disk_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/onboard_disk_info.py new file mode 100644 index 000000000..f8ecb570d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/onboard_disk_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: onboard_disk_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get onboard disks information +description: + - Get onboard disks information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Onboard test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get onboard disks information" + ieisystem.inmanage.onboard_disk_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Disk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'gethdddisk' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + disk_obj = Disk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/pcie_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/pcie_info.py new file mode 100644 index 000000000..933ccdef0 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/pcie_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: pcie_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get PCIE information +description: + - Get PCIE information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: PCIE test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get PCIE information" + ieisystem.inmanage.pcie_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class PCIE(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpcie' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + pcie_obj = PCIE(argument_spec) + pcie_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/pdisk_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/pdisk_info.py new file mode 100644 index 000000000..dbea5b681 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/pdisk_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: pdisk_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get physical disks information +description: + - Get physical disks information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Pdisk test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get physical disks information" + ieisystem.inmanage.pdisk_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Disk(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpdisk' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + disk_obj = Disk(argument_spec) + disk_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/power_budget_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/power_budget_info.py new file mode 100644 index 000000000..56fd5298d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/power_budget_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: power_budget_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get power budget information +description: + - Get power budget information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power budget test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power budget information" + ieisystem.inmanage.power_budget_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpowerbudget' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/power_consumption_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/power_consumption_info.py new file mode 100644 index 000000000..86ce5a301 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/power_consumption_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: power_consumption_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get power consumption information +description: + - Get power consumption information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power consumption test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power consumption information" + ieisystem.inmanage.power_consumption_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpowerconsumption' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/power_restore_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/power_restore_info.py new file mode 100644 index 000000000..d5c810aa7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/power_restore_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: power_restore_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get power restore information +description: + - Get power restore information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power restore test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power restore information" + ieisystem.inmanage.power_restore_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpowerrestore' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/power_status_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/power_status_info.py new file mode 100644 index 000000000..498887b66 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/power_status_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: power_status_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get power status information +description: + - Get power status information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Power status test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power status information" + ieisystem.inmanage.power_status_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Power(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpowerstatus' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + power_obj = Power(argument_spec) + power_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/preserve_config_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/preserve_config_info.py new file mode 100644 index 000000000..c7c4ba32d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/preserve_config_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: preserve_config_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get preserve config information +description: + - Get preserve config information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Preserve test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get preserve config information" + ieisystem.inmanage.preserve_config_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Preserver(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpreserveconfig' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + pre_obj = Preserver(argument_spec) + pre_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/psu_config_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/psu_config_info.py new file mode 100644 index 000000000..c0e783dbf --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/psu_config_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: psu_config_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get psu config information +description: + - Get psu config information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Psu config test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu config information" + ieisystem.inmanage.psu_config_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Psu(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpsuconfig' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + psu_obj = Psu(argument_spec) + psu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/psu_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/psu_info.py new file mode 100644 index 000000000..ec7b42fe4 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/psu_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: psu_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get psu information +description: + - Get psu information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Psu test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu information" + ieisystem.inmanage.psu_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Psu(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpsu' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + psu_obj = Psu(argument_spec) + psu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/psu_peak_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/psu_peak_info.py new file mode 100644 index 000000000..d83408821 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/psu_peak_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: psu_peak_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get psu peak information +description: + - Get psu peak information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Psu peak test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu peak information" + ieisystem.inmanage.psu_peak_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Psu(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getpsupeak' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + psu_obj = Psu(argument_spec) + psu_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/raid_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/raid_info.py new file mode 100644 index 000000000..d1db9d36c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/raid_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: raid_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get RAID/HBA card and controller information +description: + - Get RAID/HBA card and controller information information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Raid test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get raid information" + ieisystem.inmanage.raid_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Raid(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getraid' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + raid_obj = Raid(argument_spec) + raid_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/reset_bmc.py b/ansible_collections/ieisystem/inmanage/plugins/modules/reset_bmc.py new file mode 100644 index 000000000..efb00f91a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/reset_bmc.py @@ -0,0 +1,101 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: reset_bmc +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: BMC reset +description: + - BMC reset on ieisystem Server. +notes: + - Does not support C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Reset bmc test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Reset bmc" + ieisystem.inmanage.reset_bmc: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Reset(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'resetbmc' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + reset_obj = Reset(argument_spec) + reset_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/reset_kvm.py b/ansible_collections/ieisystem/inmanage/plugins/modules/reset_kvm.py new file mode 100644 index 000000000..13ad89159 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/reset_kvm.py @@ -0,0 +1,101 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: reset_kvm +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: KVM reset +description: + - KVM reset on ieisystem Server. +notes: + - Does not support C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Reset kvm test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Reset kvm" + ieisystem.inmanage.reset_kvm: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Reset(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'resetkvm' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + reset_obj = Reset(argument_spec) + reset_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/restore.py b/ansible_collections/ieisystem/inmanage/plugins/modules/restore.py new file mode 100644 index 000000000..e72f49fd8 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/restore.py @@ -0,0 +1,117 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: restore +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Restore server settings +description: + - Restore server settings on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + bak_file: + description: + - Select backup file or bak folder. + required: true + type: str + item: + description: + - Select export item. + - Only the M5 model supports this parameter. + choices: ['all', 'network', 'dns', 'service', 'ntp', 'smtp', 'snmptrap', 'ad', 'ldap', 'user', 'bios'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Restore test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Restore server settings" + ieisystem.inmanage.restore: + bak_file: "/home/wbs/backfile" + item: "all" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Restore(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'restore' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + bak_file=dict(type='str', required=True), + item=dict(type='str', required=False, choices=['all', 'network', 'dns', 'service', 'ntp', 'smtp', 'snmptrap', 'ad', 'ldap', 'user', 'bios']), + ) + argument_spec.update(inmanage_argument_spec) + restore_obj = Restore(argument_spec) + restore_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/self_test_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/self_test_info.py new file mode 100644 index 000000000..11d8cb102 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/self_test_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: self_test_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get self test information +description: + - Get self test information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Self test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get self test information" + ieisystem.inmanage.self_test_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Test(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getselftest' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + test_obj = Test(argument_spec) + test_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/sensor_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/sensor_info.py new file mode 100644 index 000000000..9376a33b9 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/sensor_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: sensor_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get sensor information +description: + - Get sensor information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Sensor test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get sensor information" + ieisystem.inmanage.sensor_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Sensor(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsensor' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + sensor_obj = Sensor(argument_spec) + sensor_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/server_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/server_info.py new file mode 100644 index 000000000..e163ee141 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/server_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: server_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get server status information +description: + - Get server status information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Server test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get server status information" + ieisystem.inmanage.server_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class ServerStatus(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getserver' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + server_obj = ServerStatus(argument_spec) + server_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/service_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/service_info.py new file mode 100644 index 000000000..6e4a6c349 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/service_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: service_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get service information +description: + - Get service information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Service info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get service information" + ieisystem.inmanage.service_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Service(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getservice' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + service_obj = Service(argument_spec) + service_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/session_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/session_info.py new file mode 100644 index 000000000..baf013980 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/session_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: session_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get online session information +description: + - Get online session information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Session test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get session information" + ieisystem.inmanage.session_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Session(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsessions' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + session_obj = Session(argument_spec) + session_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/smtp_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/smtp_info.py new file mode 100644 index 000000000..912eb344a --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/smtp_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: smtp_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get SMTP information +description: + - Get SMTP information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Smtp test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get smtp information" + ieisystem.inmanage.smtp_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SMTP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsmtp' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + smtp_obj = SMTP(argument_spec) + smtp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/snmp_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/snmp_info.py new file mode 100644 index 000000000..b337ea324 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/snmp_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: snmp_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get snmp get/set information +description: + - Get snmp get/set information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Snmp test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get snmp get/set information" + ieisystem.inmanage.snmp_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SNMP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsnmp' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + snmp_obj = SNMP(argument_spec) + snmp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/snmp_trap_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/snmp_trap_info.py new file mode 100644 index 000000000..51f1d1cd7 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/snmp_trap_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: snmp_trap_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get snmp trap information +description: + - Get snmp trap information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Trap test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get snmp trap information" + ieisystem.inmanage.snmp_trap_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SNMP(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsnmptrap' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + snmp_obj = SNMP(argument_spec) + snmp_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/support_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/support_info.py new file mode 100644 index 000000000..468f452dc --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/support_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: support_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get support information +description: + - Get the ieisystem Server support list information. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Support list test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get support information" + ieisystem.inmanage.support_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Support(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'support_model' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + support_obj = Support(argument_spec) + support_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/system_log_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/system_log_info.py new file mode 100644 index 000000000..af8775002 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/system_log_info.py @@ -0,0 +1,134 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: system_log_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get BMC system log information +description: + - Get BMC system log information on ieisystem Server. +notes: + - Supports C(check_mode). +options: + level: + description: + - Log level. + default: alert + choices: ['alert', 'critical', 'error', 'notice', 'warning', 'debug', 'emergency', 'info'] + type: str + log_time: + description: + - Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00. + type: str + count: + description: + - Get the most recent log of a specified number. + type: int + system_file: + description: + - Store logs to a file. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Bmc system log info test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc system log information" + ieisystem.inmanage.system_log_info: + level: "alert" + log_time: "2020-06-01T12:30+08:00" + provider: "{{ inmanage }}" + + - name: "Get bmc system log information" + ieisystem.inmanage.system_log_info: + count: 30 + provider: "{{ inmanage }}" + + - name: "Get bmc system log information" + ieisystem.inmanage.system_log_info: + system_file: "/home/wbs/wbs.log" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class SystemLog(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getsystemlog' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + level=dict(type='str', default='alert', choices=['alert', 'critical', 'error', 'notice', 'warning', 'debug', 'emergency', 'info']), + log_time=dict(type='str', required=False), + count=dict(type='int', required=False), + system_file=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + log_obj = SystemLog(argument_spec) + log_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/temp_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/temp_info.py new file mode 100644 index 000000000..e8cb1864c --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/temp_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: temp_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get temp information +description: + - Get temp information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Temp test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get temp information" + ieisystem.inmanage.temp_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Sensor(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'gettemp' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + sensor_obj = Sensor(argument_spec) + sensor_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/threshold_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/threshold_info.py new file mode 100644 index 000000000..d1729f5e0 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/threshold_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: threshold_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get threshold information +description: + - Get threshold information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Threshold test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get threshold information" + ieisystem.inmanage.threshold_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Threshold(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getthreshold' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + threshoold_obj = Threshold(argument_spec) + threshoold_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/uid_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/uid_info.py new file mode 100644 index 000000000..5c66a739f --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/uid_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: uid_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get UID information +description: + - Get UID information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: UID test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get UID information" + ieisystem.inmanage.uid_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class UID(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getuid' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + uid_obj = UID(argument_spec) + uid_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/update_cpld.py b/ansible_collections/ieisystem/inmanage/plugins/modules/update_cpld.py new file mode 100644 index 000000000..1823c2e57 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/update_cpld.py @@ -0,0 +1,130 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: update_cpld +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Update CPLD +description: + - Update CPLD on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + list: + description: + - Get cpld list. + - Only the M5 model supports this parameter. + choices: [True, False] + default: False + type: bool + id: + description: + - CPLD id. + - Required when I(list=False). + - Only the M5 model supports this parameter. + type: int + file_url: + description: + - CPLD image file path. + - Required when I(list=False). + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: CPLD test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get cpld list" + ieisystem.inmanage.update_cpld: + list: True + provider: "{{ inmanage }}" + + - name: "Update cpld" + update_cpld: + id: 1 + file_url: "home/wbs/raw.bin" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class CPLD(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'updatecpld' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + list=dict(type='bool', default=False, choices=[True, False]), + id=dict(type='int', required=False), + file_url=dict(type='str', required=False), + ) + argument_spec.update(inmanage_argument_spec) + cpld_obj = CPLD(argument_spec) + cpld_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/update_fw.py b/ansible_collections/ieisystem/inmanage/plugins/modules/update_fw.py new file mode 100644 index 000000000..4e2ccb224 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/update_fw.py @@ -0,0 +1,154 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: update_fw +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Update firmware +description: + - Update firmware on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + url: + description: + - Firmware image url. + required: true + type: str + mode: + description: + - Active mode, Manual or Auto(default). + default: Auto + choices: ['Auto', 'Manual'] + type: str + type: + description: + - Firmware type. + choices: ['BMC', 'BIOS'] + type: str + over_ride: + description: + - Reserve Configurations, 0-reserve, 1-override. + default: 0 + choices: [0, 1] + type: int + has_me: + description: + - Update me or not when update bios, only work in INTEL platform, 0-no, 1-yes. + - Only the M5 model supports this parameter. + default: 1 + choices: [0, 1] + type: int + dual_image: + description: + - Update dual image(default) or not. + - Only the M5 model supports this parameter. + default: dual + choices: ['single', 'dual'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Update fw test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "update bios" + ieisystem.inmanage.update_fw: + url: "/home/wbs/SA5112M5_BIOS_4.1.8_Standard_20200117.bin" + type: "BIOS" + provider: "{{ inmanage }}" + + - name: "update bmc" + ieisystem.inmanage.update_fw: + url: "/home/wbs/SA5112M5_BMC_4.17.7_Standard_20200430" + mode: "Auto" + type: "BMC" + dual_image: "dual" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Update(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'fwupdate' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + url=dict(type='str', required=True), + mode=dict(type='str', default='Auto', choices=['Auto', 'Manual']), + over_ride=dict(type='int', default=0, choices=[0, 1]), + type=dict(type='str', required=False, choices=['BMC', 'BIOS']), + has_me=dict(type='int', default=1, choices=[0, 1]), + dual_image=dict(type='str', default='dual', choices=['single', 'dual']), + ) + argument_spec.update(inmanage_argument_spec) + update_obj = Update(argument_spec) + update_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/update_psu.py b/ansible_collections/ieisystem/inmanage/plugins/modules/update_psu.py new file mode 100644 index 000000000..f2e38ee45 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/update_psu.py @@ -0,0 +1,117 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: update_psu +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Update PSU +description: + - Update psu on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + url: + description: + - Firmware image url. + required: true + type: str + mode: + description: + - Server Auto Reset Option, Manual or Auto(default). + default: Auto + choices: ['Auto', 'Manual'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Update psu test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "update psu" + ieisystem.inmanage.update_psu: + url: "/home/wbs/CRPS1300D2W_00.01.04_BootLoader_Pri_Sec.hpm" + mode: "Auto" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Update(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'updatepsu' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + url=dict(type='str', required=True), + mode=dict(type='str', default='Auto', choices=['Auto', 'Manual']), + ) + argument_spec.update(inmanage_argument_spec) + update_obj = Update(argument_spec) + update_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/user.py b/ansible_collections/ieisystem/inmanage/plugins/modules/user.py new file mode 100644 index 000000000..59dd84b26 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/user.py @@ -0,0 +1,165 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: user +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Manage user +description: + - Manage user on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + state: + description: + - Whether the user should exist or not, taking action if the state is different from what is stated. + choices: ['present', 'absent'] + default: present + type: str + uid: + description: + - User id, The range is 1 to 16. + type: int + uname: + description: + - User name, Required when uid is None. + type: str + upass: + description: + - User password. + type: str + role_id: + description: + - User group. + - Default user group 'Administrator', 'Operator', 'User'. + - Use command C(user_group_info) can get all group information. + type: str + access: + description: + - User access. + choices: ['enable', 'disable'] + type: str + priv: + description: + - Other user permissions, select one or more from None/KVM/VMM/SOL. + choices: ['kvm', 'vmm', 'sol', 'none'] + type: list + elements: str + email: + description: + - User email. + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: User test + hosts: inmanage + no_log: true + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add user" + ieisystem.inmanage.user: + state: "present" + uname: "wbs" + upass: "admin" + role_id: "Administrator" + priv: "kvm,sol" + email: "wbs@ieisystem.com" + provider: "{{ inmanage }}" + + - name: "Set user" + ieisystem.inmanage.user: + state: "present" + uname: "wbs" + upass: "12345678" + role_id: "user" + priv: "kvm,sol" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class User(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'edituser' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + state=dict(type='str', choices=['present', 'absent'], default='present'), + uid=dict(type='int', required=False), + uname=dict(type='str', required=False), + upass=dict(type='str', required=False, no_log=True), + role_id=dict(type='str', required=False), + access=dict(type='str', required=False, choices=['enable', 'disable']), + priv=dict(type='list', elements='str', required=False, choices=['kvm', 'vmm', 'sol', 'none']), + email=dict(type='str', required=False) + ) + argument_spec.update(inmanage_argument_spec) + user_obj = User(argument_spec) + user_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/user_group.py b/ansible_collections/ieisystem/inmanage/plugins/modules/user_group.py new file mode 100644 index 000000000..c858960b6 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/user_group.py @@ -0,0 +1,204 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: user_group +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Manage user group +description: + - Manage user group on ieisystem Server. +notes: + - Does not support C(check_mode). +options: + state: + description: + - Whether the user group should exist or not, taking action if the state is different from what is stated. + choices: ['present', 'absent'] + default: present + type: str + name: + description: + - Group name. + - The range of group name for M6 model is OEM1, OEM2, OEM3, OEM4. + required: true + type: str + pri: + description: + - Group privilege. + - Required when I(state=present). + - Only the M5 model supports this parameter. + choices: ['administrator', 'operator', 'user', 'oem', 'none'] + type: str + general: + description: + - General configuration privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + power: + description: + - Power control privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + media: + description: + - Remote media configuration privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + kvm: + description: + - Remote KVM configuration privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + security: + description: + - Security configuration privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + debug: + description: + - Debug diagnose privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str + self: + description: + - Itself configuration privilege. + - Required when I(state=present). + - Only the M6 model supports this parameter. + choices: ['enable', 'disable'] + type: str +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: User group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add user group" + ieisystem.inmanage.user_group: + state: "present" + name: "test" + pri: "administrator" + provider: "{{ inmanage }}" + + - name: "Set user group" + ieisystem.inmanage.user_group: + state: "present" + name: "test" + pri: "user" + provider: "{{ inmanage }}" + + - name: "Set m6 user group" + ieisystem.inmanage.user_group: + state: "present" + name: "OEM1" + general: "enable" + kvm: "enable" + provider: "{{ inmanage }}" + + - name: "Delete user group" + ieisystem.inmanage.user_group: + state: "absent" + name: "test" + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) +from ansible.module_utils.basic import AnsibleModule + + +class UserGroup(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=False) + + def run_command(self): + self.module.params['subcommand'] = 'editusergroup' + self.results = get_connection(self.module) + if self.results['State'] == 'Success': + self.results['changed'] = True + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict( + state=dict(type='str', choices=['present', 'absent'], default='present'), + name=dict(type='str', required=True), + pri=dict(type='str', required=False, choices=['administrator', 'operator', 'user', 'oem', 'none']), + general=dict(type='str', required=False, choices=['enable', 'disable']), + power=dict(type='str', required=False, choices=['enable', 'disable']), + media=dict(type='str', required=False, choices=['enable', 'disable']), + kvm=dict(type='str', required=False, choices=['enable', 'disable']), + security=dict(type='str', required=False, choices=['enable', 'disable']), + debug=dict(type='str', required=False, choices=['enable', 'disable']), + self=dict(type='str', required=False, choices=['enable', 'disable']), + ) + argument_spec.update(inmanage_argument_spec) + usergroup_obj = UserGroup(argument_spec) + usergroup_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/user_group_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/user_group_info.py new file mode 100644 index 000000000..057c74cfe --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/user_group_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: user_group_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get user group information +description: + - Get user group information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: User group test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get user group information" + ieisystem.inmanage.user_group_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class UserGroup(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getusergroup' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + usergroup_obj = UserGroup(argument_spec) + usergroup_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/user_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/user_info.py new file mode 100644 index 000000000..df548dc88 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/user_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: user_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get user information +description: + - Get user information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: User test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get user information" + ieisystem.inmanage.user_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class User(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getuser' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + user_obj = User(argument_spec) + user_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/virtual_media_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/virtual_media_info.py new file mode 100644 index 000000000..ede6f062d --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/virtual_media_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: virtual_media_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get Virtual Media information +description: + - Get Virtual Media information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Media test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get Virtual Media information" + ieisystem.inmanage.virtual_media_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Media(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getvirtualmedia' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + media_obj = Media(argument_spec) + media_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/plugins/modules/volt_info.py b/ansible_collections/ieisystem/inmanage/plugins/modules/volt_info.py new file mode 100644 index 000000000..c833aa827 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/plugins/modules/volt_info.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding:utf-8 -*- + +# Copyright(C) 2023 IEIT Inc. All Rights Reserved. +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type + +DOCUMENTATION = ''' +--- +module: volt_info +version_added: "1.0.0" +author: + - WangBaoshan (@ieisystem) +short_description: Get volt information +description: + - Get volt information on ieisystem Server. +notes: + - Supports C(check_mode). +options: {} +extends_documentation_fragment: + - ieisystem.inmanage.inmanage +''' + +EXAMPLES = ''' +- name: Volt test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get volt information" + ieisystem.inmanage.volt_info: + provider: "{{ inmanage }}" +''' + +RETURN = ''' +message: + description: Messages returned after module execution. + returned: always + type: str +state: + description: Status after module execution. + returned: always + type: str +changed: + description: Check to see if a change was made on the device. + returned: always + type: bool +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.ieisystem.inmanage.plugins.module_utils.inmanage import (inmanage_argument_spec, get_connection) + + +class Sensor(object): + def __init__(self, argument_spec): + self.spec = argument_spec + self.module = None + self.init_module() + self.results = dict() + + def init_module(self): + """Init module object""" + + self.module = AnsibleModule( + argument_spec=self.spec, supports_check_mode=True) + + def run_command(self): + self.module.params['subcommand'] = 'getvolt' + self.results = get_connection(self.module) + + def show_result(self): + """Show result""" + self.module.exit_json(**self.results) + + def work(self): + """Worker""" + self.run_command() + self.show_result() + + +def main(): + argument_spec = dict() + argument_spec.update(inmanage_argument_spec) + sensor_obj = Sensor(argument_spec) + sensor_obj.work() + + +if __name__ == '__main__': + main() diff --git a/ansible_collections/ieisystem/inmanage/requirements.txt b/ansible_collections/ieisystem/inmanage/requirements.txt new file mode 100644 index 000000000..81b70119e --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/requirements.txt @@ -0,0 +1 @@ +inManage==1.0.0
\ No newline at end of file |