From 3667197efb7b18ec842efd504785965911f8ac4b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 5 Jun 2024 18:18:34 +0200 Subject: Adding upstream version 10.0.0+dfsg. Signed-off-by: Daniel Baumann --- .../kaytus/ksmanage/docs/ad_group_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/ad_group_module.rst | 431 +++++++++++++ .../kaytus/ksmanage/docs/ad_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/adapter_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/add_ldisk_module.rst | 589 ++++++++++++++++++ .../ksmanage/docs/alert_policy_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/audit_log_info_module.rst | 358 +++++++++++ .../ksmanage/docs/auto_capture_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/backplane_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/backup_module.rst | 355 +++++++++++ .../kaytus/ksmanage/docs/bios_export_module.rst | 318 ++++++++++ .../kaytus/ksmanage/docs/bios_import_module.rst | 318 ++++++++++ .../kaytus/ksmanage/docs/bios_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/bmc_info_module.rst | 302 +++++++++ .../ksmanage/docs/boot_image_info_module.rst | 302 +++++++++ .../ksmanage/docs/boot_option_info_module.rst | 302 +++++++++ .../ksmanage/docs/clear_audit_log_module.rst | 302 +++++++++ .../ksmanage/docs/clear_event_log_module.rst | 302 +++++++++ .../ksmanage/docs/clear_system_log_module.rst | 334 ++++++++++ .../ksmanage/docs/collect_blackbox_module.rst | 319 ++++++++++ .../kaytus/ksmanage/docs/collect_log_module.rst | 318 ++++++++++ .../ksmanage/docs/connect_media_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/cpu_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/del_session_module.rst | 318 ++++++++++ .../kaytus/ksmanage/docs/dns_info_module.rst | 302 +++++++++ .../docs/download_auto_screenshot_module.rst | 318 ++++++++++ .../docs/download_manual_screenshot_module.rst | 318 ++++++++++ .../kaytus/ksmanage/docs/edit_ad_module.rst | 459 ++++++++++++++ .../ksmanage/docs/edit_alert_policy_module.rst | 430 +++++++++++++ .../ksmanage/docs/edit_auto_capture_module.rst | 322 ++++++++++ .../kaytus/ksmanage/docs/edit_bios_module.rst | 377 ++++++++++++ .../ksmanage/docs/edit_boot_image_module.rst | 327 ++++++++++ .../ksmanage/docs/edit_boot_option_module.rst | 365 +++++++++++ .../ksmanage/docs/edit_connect_media_module.rst | 360 +++++++++++ .../kaytus/ksmanage/docs/edit_dns_module.rst | 620 +++++++++++++++++++ .../ksmanage/docs/edit_event_log_policy_module.rst | 322 ++++++++++ .../kaytus/ksmanage/docs/edit_fan_module.rst | 359 +++++++++++ .../kaytus/ksmanage/docs/edit_fru_module.rst | 352 +++++++++++ .../kaytus/ksmanage/docs/edit_ipv4_module.rst | 427 +++++++++++++ .../kaytus/ksmanage/docs/edit_ipv6_module.rst | 444 +++++++++++++ .../kaytus/ksmanage/docs/edit_kvm_module.rst | 543 ++++++++++++++++ .../kaytus/ksmanage/docs/edit_ldap_module.rst | 526 ++++++++++++++++ .../kaytus/ksmanage/docs/edit_ldisk_module.rst | 378 ++++++++++++ .../ksmanage/docs/edit_log_setting_module.rst | 474 ++++++++++++++ .../ksmanage/docs/edit_m6_log_setting_module.rst | 490 +++++++++++++++ .../ksmanage/docs/edit_manual_capture_module.rst | 322 ++++++++++ .../ksmanage/docs/edit_media_instance_module.rst | 502 +++++++++++++++ .../kaytus/ksmanage/docs/edit_ncsi_module.rst | 389 ++++++++++++ .../ksmanage/docs/edit_network_bond_module.rst | 363 +++++++++++ .../ksmanage/docs/edit_network_link_module.rst | 392 ++++++++++++ .../kaytus/ksmanage/docs/edit_network_module.rst | 343 +++++++++++ .../kaytus/ksmanage/docs/edit_ntp_module.rst | 486 +++++++++++++++ .../kaytus/ksmanage/docs/edit_pdisk_module.rst | 482 +++++++++++++++ .../ksmanage/docs/edit_power_budget_module.rst | 685 +++++++++++++++++++++ .../ksmanage/docs/edit_power_restore_module.rst | 323 ++++++++++ .../ksmanage/docs/edit_power_status_module.rst | 325 ++++++++++ .../ksmanage/docs/edit_preserve_config_module.rst | 373 +++++++++++ .../ksmanage/docs/edit_psu_config_module.rst | 339 ++++++++++ .../kaytus/ksmanage/docs/edit_psu_peak_module.rst | 343 +++++++++++ .../docs/edit_restore_factory_default_module.rst | 368 +++++++++++ .../kaytus/ksmanage/docs/edit_service_module.rst | 428 +++++++++++++ .../kaytus/ksmanage/docs/edit_smtp_com_module.rst | 578 +++++++++++++++++ .../kaytus/ksmanage/docs/edit_smtp_dest_module.rst | 383 ++++++++++++ .../kaytus/ksmanage/docs/edit_smtp_module.rst | 587 ++++++++++++++++++ .../kaytus/ksmanage/docs/edit_snmp_module.rst | 540 ++++++++++++++++ .../kaytus/ksmanage/docs/edit_snmp_trap_module.rst | 598 ++++++++++++++++++ .../kaytus/ksmanage/docs/edit_threshold_module.rst | 410 ++++++++++++ .../kaytus/ksmanage/docs/edit_uid_module.rst | 343 +++++++++++ .../ksmanage/docs/edit_virtual_media_module.rst | 511 +++++++++++++++ .../kaytus/ksmanage/docs/edit_vlan_module.rst | 381 ++++++++++++ .../kaytus/ksmanage/docs/event_log_info_module.rst | 358 +++++++++++ .../ksmanage/docs/event_log_policy_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/fan_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/fru_info_module.rst | 302 +++++++++ .../ksmanage/docs/fw_version_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/gpu_info_module.rst | 303 +++++++++ .../kaytus/ksmanage/docs/hard_disk_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/hba_info_module.rst | 302 +++++++++ ansible_collections/kaytus/ksmanage/docs/index.rst | 149 +++++ .../kaytus/ksmanage/docs/kvm_info_module.rst | 302 +++++++++ .../ksmanage/docs/ldap_group_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/ldap_group_module.rst | 431 +++++++++++++ .../kaytus/ksmanage/docs/ldap_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/ldisk_info_module.rst | 302 +++++++++ .../ksmanage/docs/log_setting_info_module.rst | 302 +++++++++ .../ksmanage/docs/media_instance_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/mem_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/ncsi_info_module.rst | 302 +++++++++ .../ksmanage/docs/network_bond_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/network_info_module.rst | 302 +++++++++ .../ksmanage/docs/network_link_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/ntp_info_module.rst | 302 +++++++++ .../ksmanage/docs/onboard_disk_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/pcie_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/pdisk_info_module.rst | 302 +++++++++ .../ksmanage/docs/power_budget_info_module.rst | 302 +++++++++ .../docs/power_consumption_info_module.rst | 302 +++++++++ .../ksmanage/docs/power_restore_info_module.rst | 302 +++++++++ .../ksmanage/docs/power_status_info_module.rst | 302 +++++++++ .../ksmanage/docs/preserve_config_info_module.rst | 302 +++++++++ .../ksmanage/docs/psu_config_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/psu_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/psu_peak_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/raid_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/reset_bmc_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/reset_kvm_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/restore_module.rst | 348 +++++++++++ .../kaytus/ksmanage/docs/self_test_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/sensor_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/server_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/service_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/session_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/smtp_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/snmp_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/snmp_trap_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/support_info_module.rst | 302 +++++++++ .../ksmanage/docs/system_log_info_module.rst | 384 ++++++++++++ .../kaytus/ksmanage/docs/temp_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/threshold_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/uid_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/update_cpld_module.rst | 362 +++++++++++ .../kaytus/ksmanage/docs/update_fw_module.rst | 426 +++++++++++++ .../kaytus/ksmanage/docs/update_psu_module.rst | 338 ++++++++++ .../ksmanage/docs/user_group_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/user_group_module.rst | 532 ++++++++++++++++ .../kaytus/ksmanage/docs/user_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/user_module.rst | 454 ++++++++++++++ .../ksmanage/docs/virtual_media_info_module.rst | 302 +++++++++ .../kaytus/ksmanage/docs/volt_info_module.rst | 302 +++++++++ 129 files changed, 45774 insertions(+) create mode 100644 ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/backup_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/del_session_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/index.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/network_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/restore_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/server_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/service_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/session_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/support_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/user_group_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/user_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/user_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst create mode 100644 ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst (limited to 'ansible_collections/kaytus/ksmanage/docs') diff --git a/ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst new file mode 100644 index 000000000..123f0ef6c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ad_group_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ad_group_info -- Get active directory group information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ad_group_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get active directory group information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad group test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get active directory group information" + kaytus.ksmanage.ad_group_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst b/ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst new file mode 100644 index 000000000..bbb4efc72 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst @@ -0,0 +1,431 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ad_group_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ad_group -- Manage active directory group information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ad_group`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage active directory group information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ domain + +
+ string +
+ 		+ +
Enter the Role Group Domain. This is the domain where the role group is located.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ kvm + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
This field provides access to KVM for AD authenticated role group user.
+
+
+ name + +
+ string + / required
+ 		+ +
Enter the Role Group Name. This name identifies the role group in Active Directory.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ pri + +
+ string +
+ 		+
    Choices: +
  • administrator
    • +
  • user
    • +
  • operator
    • +
  • oem
    • +
  • none
    • +
+ 		+
Enter the Role Group Privilege. This is the level of privilege to be assigned for this role group.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Whether the active directory group should exist or not, taking action if the state is different from what is stated.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ vm + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
This field provides access to VMedia for AD authenticated role group user.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad group test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add active directory group information" + kaytus.ksmanage.ad_group: + state: "present" + name: "wbs" + domain: "test.com" + pri: "administrator" + kvm: "enable" + vm: "disable" + provider: "{{ ksmanage }}" + + - name: "Set active directory group information" + kaytus.ksmanage.ad_group: + state: "present" + name: "wbs" + pri: "user" + kvm: "disable" + provider: "{{ ksmanage }}" + + - name: "Delete active directory group information" + kaytus.ksmanage.ad_group: + state: "absent" + name: "wbs" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst new file mode 100644 index 000000000..b75defd6b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ad_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ad_info -- Get active directory information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ad_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get active directory information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get active directory information" + kaytus.ksmanage.ad_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst new file mode 100644 index 000000000..9b87ba31d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.adapter_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.adapter_info -- Get adapter information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.adapter_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get adapter information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Adapter test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get adapter information" + kaytus.ksmanage.adapter_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst b/ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst new file mode 100644 index 000000000..c5eec8c88 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst @@ -0,0 +1,589 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.add_ldisk_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.add_ldisk -- Create logical disk +++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.add_ldisk`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Create logical disk on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ accelerator + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Driver accelerator, 1 - 1h, 2 - 2h, 3 - 3h.
+
Required when controller type is PMC.
+
+
+ access + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Access Policy, 1 - Read Write, 2 - Read Only, 3 - Blocked.
+
Required when controller type is LSI.
+
+
+ cache + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Drive Cache, 1 - Unchanged, 2 - Enabled, 3 - Disabled.
+
Required when controller type is LSI.
+
+
+ ctrl_id + +
+ integer +
+ 		+ +
Raid controller ID.
+
Required when controller type is LSI, PMC or MV.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ init + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Init State, 1 - No Init, 2 - Quick Init, 3 - Full Init.
+
Required when controller type is LSI.
+
+
+ io + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
+ 		+
IO Policy, 1 - Direct IO, 2 - Cached IO.
+
Required when controller type is LSI.
+
+
+ level + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 5
    • +
  • 6
    • +
  • 10
    • +
+ 		+
RAID Level, 0 - RAID0, 1 - RAID1, 5 - RAID5, 6 - RAID6, 10 - RAID10.
+
Required when and controller type is LSI or PMC.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ r + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
+ 		+
Read Policy, 1 - Read Ahead, 2 - No Read Ahead.
+
Required when controller type is LSI.
+
+
+ select + +
+ integer +
+ 		+ +
Select Size, from 1 to 100.
+
Required when controller type is LSI.
+
+
+ size + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
  • 5
    • +
+ 		+
Strip Size, 0 - 32k, 1 - 64k, 2 - 128k, 3 - 256k, 4 - 512k, 5 - 1024k.
+
Required when Info=None and 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].
+
+
+ slot + +
+ list + / elements=integer
+ 		+ +
Slot Num, input multiple slotNumber like 0, 1, 2....
+
Required when controller type is LSI or PMC.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ vname + +
+ string +
+ 		+ +
Virtual drive name.
+
Required when controller type is PMC or server model is M7.
+
Required when controller type is MV.
+
+
+ w + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Write Policy, 1 - Write Through, 2 - Write Back, 3 - Write caching ok if bad BBU.
+
Required when controller type is LSI.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Add ldisk test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add LSI ldisk" + kaytus.ksmanage.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: "{{ ksmanage }}" + + - name: "Add PMC ldisk" + kaytus.ksmanage.add_ldisk: + ctrl_id: 0 + level: 1 + size: 1 + accelerator: 1 + slot: 0, 1 + vname: "test" + provider: "{{ ksmanage }}" + + - name: "Add MV ldisk" + kaytus.ksmanage.add_ldisk: + ctrl_id: 0 + size: 1 + vname: "test" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst new file mode 100644 index 000000000..73cca53e3 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.alert_policy_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.alert_policy_info -- Get alert policy ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.alert_policy_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get alert policy on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Alert test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get alert policy" + kaytus.ksmanage.alert_policy_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst new file mode 100644 index 000000000..e5e620208 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst @@ -0,0 +1,358 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.audit_log_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.audit_log_info -- Get BMC audit log information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.audit_log_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BMC audit log information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ audit_file + +
+ string +
+ 		+ +
Store logs to a file.
+
+
+ count + +
+ integer +
+ 		+ +
Get the most recent log of a specified number.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ log_time + +
+ string +
+ 		+ +
Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc audit log test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc audit log information" + kaytus.ksmanage.audit_log_info: + log_time: "2020-06-01T12:30+08:00" + provider: "{{ ksmanage }}" + + - name: "Get bmc audit log information" + kaytus.ksmanage.audit_log_info: + count: 30 + provider: "{{ ksmanage }}" + + - name: "Get bmc audit log information" + kaytus.ksmanage.audit_log_info: + audit_file: "/home/wbs/wbs.log" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst new file mode 100644 index 000000000..02edf7255 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.auto_capture_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.auto_capture_info -- Get auto capture screen information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.auto_capture_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get auto capture screen information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get auto capture screen information" + kaytus.ksmanage.auto_capture_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst new file mode 100644 index 000000000..e918903ce --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.backplane_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.backplane_info -- Get disk backplane information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.backplane_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get disk backplane information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Disk backplane test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get backplane information" + kaytus.ksmanage.backplane_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/backup_module.rst b/ansible_collections/kaytus/ksmanage/docs/backup_module.rst new file mode 100644 index 000000000..ee88063be --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/backup_module.rst @@ -0,0 +1,355 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.backup_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.backup -- Backup server settings +++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.backup`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Backup server settings on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bak_file + +
+ string + / required
+ 		+ +
Backup file or bak folder.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ item + +
+ string + / required
+ 		+
    Choices: +
  • all
    • +
  • network
    • +
  • service
    • +
  • ntp
    • +
  • snmptrap
    • +
  • dns
    • +
  • smtp
    • +
  • ad
    • +
  • ldap
    • +
  • user
    • +
  • bios
    • +
  • kvm
    • +
  • ipmi
    • +
  • authentication
    • +
  • syslog
    • +
  • ncsi
    • +
+ 		+
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'.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Backup test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Backup server settings" + kaytus.ksmanage.backup: + bak_file: "/home/wbs/" + item: "all" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst b/ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst new file mode 100644 index 000000000..64eb77270 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.bios_export_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.bios_export -- Export BIOS config ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.bios_export`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Export BIOS config on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string + / required
+ 		+ +
Suffix is .json/.conf, FILEURI format, "/directory/filename".
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Export bios config" + kaytus.ksmanage.bios_export: + file_url: "/home/wbs/bios.conf" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst b/ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst new file mode 100644 index 000000000..dd9e07c01 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.bios_import_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.bios_import -- Import BIOS config ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.bios_import`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Import BIOS config on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string + / required
+ 		+ +
Suffix is .json/.conf, FILEURI format, "/directory/filename".
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Import bios config" + kaytus.ksmanage.bios_import: + file_url: "/home/wbs/bios.conf" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst new file mode 100644 index 000000000..a7318a4c8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.bios_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.bios_info -- Get BIOS setup ++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.bios_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BIOS setup on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bios setup" + kaytus.ksmanage.bios_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst new file mode 100644 index 000000000..e7a44a3ba --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.bmc_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.bmc_info -- Get BMC information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.bmc_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BMC information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc info test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get BMC information" + kaytus.ksmanage.bmc_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst new file mode 100644 index 000000000..400782f81 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.boot_image_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.boot_image_info -- Get bmc boot image information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.boot_image_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get bmc boot image information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot image test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc boot image information" + kaytus.ksmanage.boot_image_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst new file mode 100644 index 000000000..30efdda01 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.boot_option_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.boot_option_info -- Get BIOS boot options ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.boot_option_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BIOS boot options on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bios boot option" + kaytus.ksmanage.boot_option_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst new file mode 100644 index 000000000..8b38949c4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.clear_audit_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.clear_audit_log -- Clear BMC audit log +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.clear_audit_log`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Clear BMC audit log on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Clear BMC audit log test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear BMC audit log " + kaytus.ksmanage.clear_audit_log: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst new file mode 100644 index 000000000..095526741 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.clear_event_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.clear_event_log -- Clear event log +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.clear_event_log`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Clear event log on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Clear event log test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear event log" + kaytus.ksmanage.clear_event_log: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst new file mode 100644 index 000000000..561df8d35 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst @@ -0,0 +1,334 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.clear_system_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.clear_system_log -- Clear BMC system log +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.clear_system_log`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Clear BMC system log on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • alert ←
    • +
  • critical
    • +
  • error
    • +
  • notice
    • +
  • warning
    • +
  • debug
    • +
  • emergency
    • +
  • info
    • +
  • all
    • +
+ 		+
Log level.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Clear BMC system log test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Clear BMC system log" + kaytus.ksmanage.clear_system_log: + level: "alert" + provider: "{{ ksmanage }}" + + - name: "Clear BMC system log" + kaytus.ksmanage.clear_system_log: + level: "all" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst b/ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst new file mode 100644 index 000000000..1a2268bce --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst @@ -0,0 +1,319 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.collect_blackbox_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.collect_blackbox -- Collect blackbox log +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.collect_blackbox`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Collect blackbox log on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string + / required
+ 		+ +
File download path.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Collect blackbox test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Collect blackbox log" + kaytus.ksmanage.collect_blackbox: + file_url: "/home/wbs/wbs.log" + provider: "{{ ksmanage }}" + + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst new file mode 100644 index 000000000..6786d75c1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.collect_log_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.collect_log -- Collect logs ++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.collect_log`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Collect logs on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string + / required
+ 		+ +
File download path or path with filename, for example filepath/filename.tar.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Collect test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Collect logs" + kaytus.ksmanage.collect_log: + file_url: "/home/wbs/test.tar" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst new file mode 100644 index 000000000..41e742ed6 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.connect_media_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.connect_media_info -- Get remote images redirection information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.connect_media_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get remote images redirection information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Connect media test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get remote images redirection information" + kaytus.ksmanage.connect_media_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst new file mode 100644 index 000000000..49bab2565 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.cpu_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.cpu_info -- Get CPU information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.cpu_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get CPU information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: CPU test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get cpu information" + kaytus.ksmanage.cpu_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/del_session_module.rst b/ansible_collections/kaytus/ksmanage/docs/del_session_module.rst new file mode 100644 index 000000000..ea4c6630c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/del_session_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.del_session_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.del_session -- Delete session ++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.del_session`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Delete session on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ sid + +
+ string + / required
+ 		+ +
Session Id, input "all" to delete all sessions.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Delete session test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Delete session" + kaytus.ksmanage.del_session: + sid: "223" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst new file mode 100644 index 000000000..c183ea16d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.dns_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.dns_info -- Get dns information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.dns_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get dns information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: DNS test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get dns information" + kaytus.ksmanage.dns_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst b/ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst new file mode 100644 index 000000000..767f2e6d8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.download_auto_screenshot_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.download_auto_screenshot -- Download auto screenshots ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.download_auto_screenshot`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Download auto screenshots on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string + / required
+ 		+ +
Screen capture file path.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Download auto screenshots" + kaytus.ksmanage.download_auto_screenshot: + file_url: "/home/wbs/screen" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst b/ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst new file mode 100644 index 000000000..4cbe1fba2 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst @@ -0,0 +1,318 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.download_manual_screenshot_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.download_manual_screenshot -- Download manual screenshots ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.download_manual_screenshot`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Download manual screenshots on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string + / required
+ 		+ +
Screen capture file path.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Download manual screenshots" + kaytus.ksmanage.download_manual_screenshot: + file_url: "/home/wbs/screen" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst new file mode 100644 index 000000000..a0116cd7c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst @@ -0,0 +1,459 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ad_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ad -- Set active directory information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ad`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set active directory information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ addr1 + +
+ string +
+ 		+ +
Domain Controller Server Address1. Enter the IP address of Active Directory server.
+
+
+ addr2 + +
+ string +
+ 		+ +
Domain Controller Server Address2. Enter the IP address of Active Directory server.
+
+
+ addr3 + +
+ string +
+ 		+ +
Domain Controller Server Address3. Enter the IP address of Active Directory server.
+
+
+ code + +
+ string +
+ 		+ +
Secret Password. Specify the Password of the administrator.
+
+
+ domain + +
+ string +
+ 		+ +
User Domain Name. Specify the Domain Name for the user for example MyDomain.com.
+
+
+ enable + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Active Directory Authentication Status.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ name + +
+ string +
+ 		+ +
Secret Username. Specify the Username of an administrator of the Active Directory Server.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ ssl_enable + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Active Directory SSL Status.
+
+
+ timeout + +
+ integer +
+ 		+ +
The Time Out configuration(15-300).
+
Only the M5 model supports this parameter.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ad test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set active directory information" + kaytus.ksmanage.edit_ad: + enable: "disable" + provider: "{{ ksmanage }}" + + - name: "Set active directory information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst new file mode 100644 index 000000000..bf081d5d1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst @@ -0,0 +1,430 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_alert_policy_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_alert_policy -- Set alert policy ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_alert_policy`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set alert policy on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ channel + +
+ string +
+ 		+
    Choices: +
  • shared
    • +
  • dedicated
    • +
+ 		+
LAN Channel.
+
Only the M5 model supports this parameter.
+
+
+ destination + +
+ string +
+ 		+ +
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.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ id + +
+ integer + / required
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
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.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Alert policy status. Whether to enable the receiving end for sending messages in trap mode.
+
+
+ trap_port + +
+ integer +
+ 		+ +
SNMP trap port(1-65535).
+
Only the M6 model supports this parameter.
+
+
+ type + +
+ string +
+ 		+
    Choices: +
  • snmp
    • +
  • email
    • +
  • snmpdomain
    • +
+ 		+
Alert Type.
+
Only the M5 model supports this parameter.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Alert policy test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set alert policy" + kaytus.ksmanage.edit_alert_policy: + id: 1 + status: "enable" + type: "snmp" + destination: "100.2.2.2" + channel: "shared" + provider: "{{ ksmanage }}" + + - name: "Set alert policy" + kaytus.ksmanage.edit_alert_policy: + id: 1 + status: "disable" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst new file mode 100644 index 000000000..afe6776c8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst @@ -0,0 +1,322 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_auto_capture_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_auto_capture -- Set auto capture screen +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_auto_capture`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set auto capture screen on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ status + +
+ string + / required
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Capture status.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set auto capture screen" + kaytus.ksmanage.edit_auto_capture: + status: "enable" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst new file mode 100644 index 000000000..ecc2eed00 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst @@ -0,0 +1,377 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_bios_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_bios -- Set BIOS setup attributes +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_bios`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set BIOS setup attributes on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ attribute + +
+ string +
+ 		+ +
BIOS setup option.
+
Required when list=False and file_url=None.
+
+
+ file_url + +
+ string +
+ 		+ +
BIOS option file. attribute must be used with value.
+
Mutually exclusive with fileurl format, "/directory/filename".
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ list + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Show attribute name and configurable value.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ value + +
+ string +
+ 		+ +
BIOS setup option value.
+
Required when list=False and file_url=None.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bios test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bios setup" + kaytus.ksmanage.edit_bios: + attribute: "VMX" + value: "Disable" + provider: "{{ ksmanage }}" + + - name: "Set bios setup" + kaytus.ksmanage.edit_bios: + attribute: "VMX" + value: "Enable" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst new file mode 100644 index 000000000..c8443f0e9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst @@ -0,0 +1,327 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_boot_image_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_boot_image -- Set bmc boot image ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_boot_image`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set bmc boot image on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ image + +
+ integer + / required
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
  • 5
    • +
+ 		+
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.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot image test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bmc boot image" + kaytus.ksmanage.edit_boot_image: + image: 2 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst new file mode 100644 index 000000000..b3ef68d54 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst @@ -0,0 +1,365 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_boot_option_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_boot_option -- Set BIOS boot options ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_boot_option`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set BIOS boot options on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ device + +
+ string +
+ 		+
    Choices: +
  • none
    • +
  • HDD
    • +
  • PXE
    • +
  • CD
    • +
  • BIOSSETUP
    • +
+ 		+
Boot device.
+
+
+ effective + +
+ string +
+ 		+
    Choices: +
  • Once
    • +
  • Continuous
    • +
+ 		+
Effective, once or continuous.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • Legacy
    • +
  • UEFI
    • +
+ 		+
Boot type.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Boot test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set bios boot option" + kaytus.ksmanage.edit_boot_option: + device: "PXE" + effective: "Once" + mode: "Legacy" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst new file mode 100644 index 000000000..f4eb71c0e --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst @@ -0,0 +1,360 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_connect_media_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_connect_media -- Start/Stop virtual media Image +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_connect_media`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Start/Stop virtual media Image on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ image_name + +
+ string + / required
+ 		+ +
Image name.
+
+
+ image_type + +
+ string + / required
+ 		+
    Choices: +
  • CD
    • +
  • FD
    • +
  • HD
    • +
+ 		+
Virtual media type.
+
Only the M5 model supports this parameter.
+
+
+ op_type + +
+ string + / required
+ 		+
    Choices: +
  • start
    • +
  • stop
    • +
+ 		+
Start or stop media.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Connect media test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set remote image redirection" + kaytus.ksmanage.edit_connect_media: + image_type: "CD" + op_type: "start" + image_name: "aa.iso" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst new file mode 100644 index 000000000..f436412dc --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst @@ -0,0 +1,620 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_dns_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_dns -- Set dns information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_dns`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set dns information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ dns_iface + +
+ string +
+ 		+ +
DNS Interface, input like 'eth0', 'eth1', 'bond0'.
+
Required when dns_manual=auto.
+
+
+ dns_manual + +
+ string +
+ 		+
    Choices: +
  • manual
    • +
  • auto
    • +
+ 		+
DNS Settings. Select whether the DNS interface will be configured manually or automatically.
+
+
+ dns_priority + +
+ string +
+ 		+
    Choices: +
  • 4
    • +
  • 6
    • +
+ 		+
IP Priority.
+
Required when dns_manual=auto.
+
+
+ dns_server1 + +
+ string +
+ 		+ +
DNS Server1 IPv4 or IPv6 address.
+
Required when dns_manual=manual.
+
+
+ dns_server2 + +
+ string +
+ 		+ +
DNS Server2 IPv4 or IPv6 address.
+
Required when dns_manual=manual.
+
+
+ dns_server3 + +
+ string +
+ 		+ +
DNS Server3 IPv4 or IPv6 address.
+
Required when dns_manual=manual.
+
+
+ dns_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
DNS status.
+
+
+ domain_iface + +
+ string +
+ 		+ +
Network Interface, input like 'eth0_v4', 'eth0_v6', 'eth1_v4', 'eth1_v6', 'bond0_v4', 'bond0_v6'.
+
Required when domain_manual=auto.
+
+
+ domain_manual + +
+ string +
+ 		+
    Choices: +
  • manual
    • +
  • auto
    • +
+ 		+
Domain Settings. Select whether the domain interface will be configured manually or automatically.
+
+
+ domain_name + +
+ string +
+ 		+ +
Domain Name.
+
Required when domain_manual=manual.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ host_cfg + +
+ string +
+ 		+
    Choices: +
  • manual
    • +
  • auto
    • +
+ 		+
Host Settings. Select whether the host name will be configured manually or automatically.
+
+
+ host_name + +
+ string +
+ 		+ +
Host Name.
+
Required when host_cfg=manual.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ register_status1 + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
BMC register status 1.
+
Only the M6 model supports this parameter.
+
+
+ register_status2 + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
BMC register status 2.
+
Only the M6 model supports this parameter.
+
+
+ registration_method1 + +
+ string +
+ 		+
    Choices: +
  • nsupdate
    • +
  • dhcp
    • +
  • hostname
    • +
+ 		+
Registration method 1.
+
Only the M6 model supports this parameter.
+
Required when register_status1=enable.
+
+
+ registration_method2 + +
+ string +
+ 		+
    Choices: +
  • nsupdate
    • +
  • dhcp
    • +
  • hostname
    • +
+ 		+
Registration method 2.
+
Only the M6 model supports this parameter.
+
Required when register_status2=enable.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: DNS test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set dns information" + kaytus.ksmanage.edit_dns: + dns_status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set dns information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + - name: "Set dns information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst new file mode 100644 index 000000000..3161894bb --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst @@ -0,0 +1,322 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_event_log_policy_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_event_log_policy -- Set event log policy ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_event_log_policy`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set event log policy on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ policy + +
+ string + / required
+ 		+
    Choices: +
  • Linear
    • +
  • Circular
    • +
+ 		+
Event log policy.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Event log policy test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set event log policy" + kaytus.ksmanage.edit_event_log_policy: + policy: "Linear" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst new file mode 100644 index 000000000..403c59785 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst @@ -0,0 +1,359 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_fan_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_fan -- Set fan information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_fan`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set fan information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ fan_speed + +
+ integer +
+ 		+ +
Fan speed (duty ratio), range in 1 - 100.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ id + +
+ integer +
+ 		+ +
Fan id 255 is for all fans, 0~n.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • Automatic
    • +
  • Manual
    • +
+ 		+
Control mode, Manual or Automatic , Manual must be used with fans_peed.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fan test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set fan information" + kaytus.ksmanage.edit_fan: + mode: "Automatic" + provider: "{{ ksmanage }}" + + - name: "Set fan information" + kaytus.ksmanage.edit_fan: + mode: "Manual" + id: 1 + fan_speed: 80 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst new file mode 100644 index 000000000..f205bb1fd --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst @@ -0,0 +1,352 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_fru_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_fru -- Set fru settings +++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_fru`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set fru settings on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ attribute + +
+ string + / required
+ 		+
    Choices: +
  • CP
    • +
  • CS
    • +
  • PM
    • +
  • PPN
    • +
  • PS
    • +
  • PN
    • +
  • PV
    • +
  • PAT
    • +
  • BM
    • +
  • BPN
    • +
  • BS
    • +
  • BP
    • +
+ 		+
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.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ value + +
+ string + / required
+ 		+ +
Set the value of attribute.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fru test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set Fru" + kaytus.ksmanage.edit_fru: + attribute: "CP" + value: "test" + provider: "{{ ksmanage }}" + + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst new file mode 100644 index 000000000..1e87370c3 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst @@ -0,0 +1,427 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ipv4_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ipv4 -- Set ipv4 information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ipv4`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ipv4 information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface_name + +
+ string + / required
+ 		+
    Choices: +
  • eth0
    • +
  • eth1
    • +
  • bond0
    • +
+ 		+
Set interface name. Select the LAN interface to be configured.
+
+
+ ipv4_address + +
+ string +
+ 		+ +
If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface.
+
Required when ipv4_dhcp_enable=static.
+
+
+ ipv4_dhcp_enable + +
+ string +
+ 		+
    Choices: +
  • dhcp
    • +
  • static
    • +
+ 		+
Enable 'Enable DHCP' to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP).
+
+
+ ipv4_gateway + +
+ string +
+ 		+ +
If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.
+
Required when ipv4_dhcp_enable=static.
+
+
+ ipv4_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable or disable IPV4.
+
+
+ ipv4_subnet + +
+ string +
+ 		+ +
If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface.
+
Required when ipv4_dhcp_enable=static.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ipv4 test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ipv4 information" + kaytus.ksmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set ipv4 information" + kaytus.ksmanage.edit_ipv4: + interface_name: "eth0" + ipv4_status: "enable" + ipv4_dhcp_enable: "dhcp" + provider: "{{ ksmanage }}" + + - name: "Set ipv4 information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst new file mode 100644 index 000000000..69cb8acb8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst @@ -0,0 +1,444 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ipv6_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ipv6 -- Set ipv6 information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ipv6`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ipv6 information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface_name + +
+ string + / required
+ 		+
    Choices: +
  • eth0
    • +
  • eth1
    • +
  • bond0
    • +
+ 		+
Set interface name. Select the LAN interface to be configured.
+
+
+ ipv6_address + +
+ string +
+ 		+ +
If DHCP is disabled, specify a static IPv6 address to be configured for the selected interface.
+
Required when ipv6_dhcp_enable=static.
+
+
+ ipv6_dhcp_enable + +
+ string +
+ 		+
    Choices: +
  • dhcp
    • +
  • static
    • +
+ 		+
Enable 'Enable DHCP' to dynamically configure IPv6 address using Dynamic Host Configuration Protocol (DHCP).
+
+
+ ipv6_gateway + +
+ string +
+ 		+ +
If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.
+
Required when ipv6_dhcp_enable=static.
+
+
+ ipv6_index + +
+ integer +
+ 		+ +
Ipv6 index(0-15).
+
Required when ipv6_dhcp_enable=static.
+
+
+ ipv6_prefix + +
+ integer +
+ 		+ +
The subnet prefix length for the IPv6 settings(0-128).
+
Required when ipv6_dhcp_enable=static.
+
+
+ ipv6_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable or disable IPV6.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ipv6 test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ipv6 information" + kaytus.ksmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set ipv6 information" + kaytus.ksmanage.edit_ipv6: + interface_name: "eth0" + ipv6_status: "enable" + ipv6_dhcp_enable: "dhcp" + provider: "{{ ksmanage }}" + + - name: "Set ipv6 information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst new file mode 100644 index 000000000..bf4d36aaa --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst @@ -0,0 +1,543 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_kvm_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_kvm -- Set KVM ++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_kvm`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set KVM on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ automatic_off + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Automatically OFF Server Monitor, When KVM Launches.
+
+
+ client_type + +
+ string +
+ 		+
    Choices: +
  • vnc
    • +
  • viewer
    • +
+ 		+
Client Type.
+
Only the M6 model supports this parameter.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ keyboard_language + +
+ string +
+ 		+
    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
    • +
+ 		+
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.
+
+
+ kvm_encryption + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Encrypt KVM packets.
+
+
+ local_monitor_off + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Server Monitor OFF Feature Status.
+
+
+ media_attach + +
+ string +
+ 		+
    Choices: +
  • attach
    • +
  • auto
    • +
+ 		+
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.
+
+
+ non_secure + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/disable Non Secure Connection Type.
+
Only the M6 model supports this parameter.
+
Required when client_type=vnc.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ retry_count + +
+ integer +
+ 		+ +
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.
+
+
+ retry_time_interval + +
+ integer +
+ 		+ +
The Identification for retry time interval configuration (5-30) seconds.
+
Only the M5 model supports this parameter.
+
+
+ ssh_vnc + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/disable VNC over SSH in BMC.
+
Only the M6 model supports this parameter.
+
Required when client_type=vnc.
+
+
+ stunnel_vnc + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/disable VNC over Stunnel in BMC.
+
Only the M6 model supports this parameter.
+
Required when client_type=vnc.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: KVM test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set KVM" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst new file mode 100644 index 000000000..99b725d90 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst @@ -0,0 +1,526 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ldap_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ldap -- Set ldap information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ldap`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ldap information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ address + +
+ string +
+ 		+ +
Server Address.
+
+
+ attr + +
+ string +
+ 		+
    Choices: +
  • cn
    • +
  • uid
    • +
+ 		+
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.
+
+
+ base + +
+ string +
+ 		+ +
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.
+
+
+ ca + +
+ string +
+ 		+ +
CA certificate file path.
+
Required when encry=StartTLS.
+
+
+ ce + +
+ string +
+ 		+ +
Certificate file path.
+
Required when encry=StartTLS.
+
+
+ cn + +
+ string +
+ 		+
    Choices: +
  • ip
    • +
  • fqdn
    • +
+ 		+
Common name type.
+
Required when encry=StartTLS.
+
+
+ code + +
+ string +
+ 		+ +
Password. The Bind password is also used in the bind authentication operations between client and server.
+
Required when enable=enable.
+
+
+ dn + +
+ string +
+ 		+ +
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.
+
+
+ enable + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
LDAP/E-Directory Authentication Status.
+
+
+ encry + +
+ string +
+ 		+
    Choices: +
  • no
    • +
  • SSL
    • +
  • StartTLS
    • +
+ 		+
Encryption Type.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ pk + +
+ string +
+ 		+ +
Private Key file path.
+
Required when encry=StartTLS.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ server_port + +
+ integer +
+ 		+ +
Server Port. Specify the LDAP/E-Directory Port.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ldap information" + kaytus.ksmanage.edit_ldap: + enable: "disable" + provider: "{{ ksmanage }}" + + - name: "Set ldap information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst new file mode 100644 index 000000000..50b3a7bc5 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst @@ -0,0 +1,378 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ldisk_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ldisk -- Set logical disk +++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ldisk`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set logical disk on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ ctrl_id + +
+ integer +
+ 		+ +
Raid controller ID.
+
+
+ duration + +
+ integer +
+ 		+ +
Duration range is 1-255, physical drive under PMC raid controller.
+
Required when option=LOC.
+
Only the M6 model supports this parameter.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ ldisk_id + +
+ integer +
+ 		+ +
Logical disk ID.
+
+
+ option + +
+ string +
+ 		+
    Choices: +
  • LOC
    • +
  • STL
    • +
  • FI
    • +
  • SFI
    • +
  • SI
    • +
  • DEL
    • +
+ 		+
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.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit ldisk test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit ldisk" + kaytus.ksmanage.edit_ldisk: + ctrl_id: 0 + ldisk_id: 1 + option: "LOC" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst new file mode 100644 index 000000000..5cec4672c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst @@ -0,0 +1,474 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_log_setting_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_log_setting -- Set bmc system and audit log setting +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_log_setting`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set bmc system and audit log setting on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ audit_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Audit Log Status.
+
+
+ audit_type + +
+ string +
+ 		+
    Choices: +
  • local
    • +
  • remote
    • +
  • both
    • +
+ 		+
Audit log type.
+
+
+ file_size + +
+ integer +
+ 		+ +
File Size(3-65535bytes), set when type is local(default 30000).
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ protocol_type + +
+ string +
+ 		+
    Choices: +
  • UDP
    • +
  • TCP
    • +
+ 		+
Protocol Type, set when type is remote.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ rotate_count + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
+ 		+
Rotate Count, set when type is local, 0-delete old files(default), 1-bak old files.
+
+
+ server_addr + +
+ string +
+ 		+ +
Server Address, set when type is remote.
+
+
+ server_port + +
+ integer +
+ 		+ +
Server Port(0-65535), set when type is remote.
+
+
+ status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
System Log Status.
+
+
+ type + +
+ string +
+ 		+
    Choices: +
  • local
    • +
  • remote
    • +
  • both
    • +
+ 		+
System log type.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit log setting test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit bmc system log setting" + kaytus.ksmanage.edit_log_setting: + status: "enable" + type: "both" + provider: "{{ ksmanage }}" + + - name: "Edit bmc audit log setting" + kaytus.ksmanage.edit_log_setting: + audit_status: "enable" + audit_type: "remote" + server_addr: "100.2.126.11" + server_port: "514" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst new file mode 100644 index 000000000..4468a6a03 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst @@ -0,0 +1,490 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_m6_log_setting_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_m6_log_setting -- Set bmc system and audit log setting ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_m6_log_setting`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set bmc system and audit log setting on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ host_tag + +
+ string +
+ 		+
    Choices: +
  • HostName
    • +
  • SerialNum
    • +
  • AssertTag
    • +
+ 		+
System log host tag, set when status=enable.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • Critical
    • +
  • Warning
    • +
  • Info
    • +
+ 		+
Events Level, set when status=enable.
+
+
+ log_type + +
+ string +
+ 		+
    Choices: +
  • idl
    • +
  • audit
    • +
  • both
    • +
+ 		+
Remote Log Type, set when server_id is not none.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ protocol_type + +
+ string +
+ 		+
    Choices: +
  • UDP
    • +
  • TCP
    • +
+ 		+
Protocol Type, set when status=enable.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ server_addr + +
+ string +
+ 		+ +
Server Address, set when server_id is not none.
+
+
+ server_id + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Syslog Server ID, set when status=enable.
+
+
+ server_port + +
+ integer +
+ 		+ +
Server Address, set when server_id is not none.
+
+
+ status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
System Log Status.
+
+
+ test + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Test remote log settings, set when server_id is not none.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit log setting test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit bmc system log setting" + kaytus.ksmanage.edit_m6_log_setting: + status: "disable" + provider: "{{ ksmanage }}" + + - name: "Edit bmc audit log setting" + kaytus.ksmanage.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: "{{ ksmanage }}" + + - name: "test bmc audit log" + kaytus.ksmanage.edit_m6_log_setting: + server_id: 0 + test: True + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst new file mode 100644 index 000000000..569225d31 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst @@ -0,0 +1,322 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_manual_capture_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_manual_capture -- Set manual capture screen +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_manual_capture`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set manual capture screen on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ type + +
+ string + / required
+ 		+
    Choices: +
  • capture
    • +
  • delete
    • +
+ 		+
Manual type.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Screen test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set manual capture screen" + kaytus.ksmanage.edit_manual_capture: + type: "capture" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst new file mode 100644 index 000000000..8120c19d4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst @@ -0,0 +1,502 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_media_instance_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_media_instance -- Set Virtual Media Instance ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_media_instance`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set Virtual Media Instance on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ kvm_num_cd + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
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.
+
+
+ kvm_num_fd + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Select the number of Remote KVM floppy devices that support for Virtual Media redirection.
+
+
+ kvm_num_hd + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection.
+
+
+ num_cd + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Select the number of CD/DVD devices that support for Virtual Media redirection.
+
+
+ num_fd + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Select the number of floppy devices that support for Virtual Media redirection.
+
+
+ num_hd + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Select the number of harddisk devices that support for Virtual Media redirection.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ power_save_mode + +
+ string +
+ 		+
    Choices: +
  • Enable
    • +
  • Disable
    • +
+ 		+
Check this option to enable Power Save Mode in BMC.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ sd_media + +
+ string +
+ 		+
    Choices: +
  • Enable
    • +
  • Disable
    • +
+ 		+
Check this option to enable SD Media support in BMC.
+
+
+ secure_channel + +
+ string +
+ 		+
    Choices: +
  • Enable
    • +
  • Disable
    • +
+ 		+
Check this option to enable encrypt media recirection packets.
+
Only the M5/M6 model supports this parameter.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media instance test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set media instance" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst new file mode 100644 index 000000000..d3fe17c74 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst @@ -0,0 +1,389 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ncsi_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ncsi -- Set ncsi information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ncsi`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set ncsi information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ channel_number + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
Channel number.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface_name + +
+ string +
+ 		+ +
Interface name, for example eth0.
+
Only the M5 model supports this parameter.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • auto
    • +
  • manual
    • +
  • Disable
    • +
+ 		+
NCSI mode, auto-Auto Failover, manual-Manual Switch.
+
Only M6 model supports Disable Settings.
+
+
+ nic_type + +
+ string +
+ 		+
    Choices: +
  • PHY
    • +
  • OCP
    • +
  • OCP1
    • +
  • PCIE
    • +
  • auto
    • +
  • Disable
    • +
+ 		+
Nic type.
+
Only NF3280A6 and NF3180A6 model supports Disable Settings, but not support PHY Settings.
+
M6 model only support OCP, OCP1, PCIE settings.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NCSI test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ncsi information" + kaytus.ksmanage.edit_ncsi: + mode: "manual" + nic_type: "PCIE" + interface_name: "eth0" + channel_number: 1 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst new file mode 100644 index 000000000..7be810932 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst @@ -0,0 +1,363 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_network_bond_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_network_bond -- Set network bond ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_network_bond`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set network bond on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_config + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable this option to configure the interfaces in service configuration automatically.
+
+
+ bond + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Network bond status, If VLAN is enabled for slave interfaces, then Bonding cannot be enabled.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface + +
+ string +
+ 		+
    Choices: +
  • shared
    • +
  • dedicated
    • +
  • both
    • +
+ 		+
Interface name.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bond test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network bond" + kaytus.ksmanage.edit_network_bond: + bond: "enable" + interface: "dedicated" + auto_config: "enable" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst new file mode 100644 index 000000000..997d8d2d9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst @@ -0,0 +1,392 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_network_link_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_network_link -- Set network link ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_network_link`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set network link on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_nego + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
This option allows the device to perform auto-configuration.
+
To achieve the best mode of operation (speed and duplex) on the link.
+
+
+ duplex_mode + +
+ string +
+ 		+
    Choices: +
  • HALF
    • +
  • FULL
    • +
+ 		+
Select any one of the following Duplex Mode.
+
Required when auto_nego=disable.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface + +
+ string + / required
+ 		+
    Choices: +
  • shared
    • +
  • dedicated
    • +
  • both
    • +
+ 		+
Interface name.
+
+ + link_speed + +
+ integer +
+ 		+
    Choices: +
  • 10
    • +
  • 100
    • +
+ 		+
Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps.
+
Required when auto_nego=disable.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Link test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network link" + kaytus.ksmanage.edit_network_link: + interface: "dedicated" + auto_nego: "enable" + provider: "{{ ksmanage }}" + + - name: "Set network link" + kaytus.ksmanage.edit_network_link: + interface: "dedicated" + auto_nego: "disable" + link_speed: 100 + duplex_mode: "FULL" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst new file mode 100644 index 000000000..c22cbccb5 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst @@ -0,0 +1,343 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_network_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_network -- Set network information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_network`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set network information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface_name + +
+ string + / required
+ 		+
    Choices: +
  • eth0
    • +
  • eth1
    • +
  • bond0
    • +
+ 		+
Set interface name. Select the LAN interface to be configured.
+
+
+ lan_enable + +
+ string + / required
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable or disable this interface. If disable, you cannot use this interface any more.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Network test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set network information" + kaytus.ksmanage.edit_network: + interface_name: "eth0" + lan_enable: "enable" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst new file mode 100644 index 000000000..ecf48a766 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst @@ -0,0 +1,486 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_ntp_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_ntp -- Set NTP ++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ntp`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set NTP on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_date + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Date auto synchronize.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ max_variety + +
+ integer +
+ 		+ +
NTP Maximum jump time(minute), max variety(1-60).
+
Only the M6 model supports this parameter.
+
+
+ ntp_time + +
+ string +
+ 		+ +
NTP time(YYYYmmddHHMMSS).
+
Only the M5 model supports this parameter.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ server1 + +
+ string +
+ 		+ +
NTP Server1(ipv4 or ipv6 or domain name), set when auto_date is enable.
+
+
+ server2 + +
+ string +
+ 		+ +
NTP Server2(ipv4 or ipv6 or domain name), set when auto_date is enable.
+
+
+ server3 + +
+ string +
+ 		+ +
NTP Server3(ipv4 or ipv6 or domain name), set when auto_date is enable.
+
+
+ server4 + +
+ string +
+ 		+ +
NTP Server4(ipv4 or ipv6 or domain name), set when auto_date is enable.
+
+
+ server5 + +
+ string +
+ 		+ +
NTP Server5(ipv4 or ipv6 or domain name), set when auto_date is enable.
+
+
+ server6 + +
+ string +
+ 		+ +
NTP Server6(ipv4 or ipv6 or domain name), set when auto_date is enable.
+
+
+ syn_cycle + +
+ integer +
+ 		+ +
NTP syn cycle(minute), sync cycle(5-1440).
+
+
+ time_zone + +
+ string +
+ 		+ +
UTC time zone, chose from {-12, -11.5, -11, ... , 11, 11.5, 12}.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NTP test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set ntp" + kaytus.ksmanage.edit_ntp: + auto_date: "enable" + server2: "time.nist.gov" + provider: "{{ ksmanage }}" + + - name: "Set ntp" + kaytus.ksmanage.edit_ntp: + auto_date: "disable" + ntp_time: "20200609083600" + provider: "{{ ksmanage }}" + + - name: "set ntp" + kaytus.ksmanage.edit_ntp: + time_zone: "8" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst new file mode 100644 index 000000000..db2e9118d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst @@ -0,0 +1,482 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_pdisk_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_pdisk -- Set physical disk ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_pdisk`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set physical disk on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ action + +
+ string +
+ 		+
    Choices: +
  • remove
    • +
  • global
    • +
  • dedicate
    • +
+ 		+
Action while set physical drive hotspare.
+
Required when option=HS.
+
Only the M5 model supports this parameter.
+
+
+ ctrl_id + +
+ integer +
+ 		+ +
Raid controller ID.
+
+
+ device_id + +
+ integer +
+ 		+ +
Physical drive id.
+
+
+ duration + +
+ integer +
+ 		+ +
Duration range is 1-255, physical drive under PMC raid controller.
+
Required when option=LOC.
+
Only the M6 model supports this parameter.
+
+
+ encl + +
+ string +
+ 		+
    Choices: +
  • yes
    • +
  • no
    • +
+ 		+
IsEnclAffinity while set physical drive hotspare.
+
Required when option=HS and action=dedicate.
+
Only the M5 model supports this parameter.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ logical_drivers + +
+ list + / elements=integer
+ 		+ +
Logical Drivers while set physical drive hotspare, input multiple Logical Drivers index like 0, 1, 2.....
+
Required when option=HS and action=dedicate.
+
Only the M5 model supports this parameter.
+
+
+ option + +
+ string +
+ 		+
    Choices: +
  • UG
    • +
  • UB
    • +
  • OFF
    • +
  • FAIL
    • +
  • RBD
    • +
  • ON
    • +
  • JB
    • +
  • ES
    • +
  • EM
    • +
  • EN
    • +
  • ET
    • +
  • LOC
    • +
  • STL
    • +
  • HS
    • +
+ 		+
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 HS Settings.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ revertible + +
+ string +
+ 		+
    Choices: +
  • yes
    • +
  • no
    • +
+ 		+
IsRevertible while set physical drive hotspare.
+
Required when option=HS and action=dedicate.
+
Only the M5 model supports this parameter.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit pdisk test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit pdisk" + kaytus.ksmanage.edit_pdisk: + ctrl_id: 0 + device_id: 1 + option: "LOC" + provider: "{{ ksmanage }}" + + - name: "M5 Edit pdisk" + kaytus.ksmanage.edit_pdisk: + ctrl_id: 0 + device_id: 1 + option: "HS" + action: "dedicate" + revertible: "yes" + encl: "yes" + logical_drivers: 1 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst new file mode 100644 index 000000000..7d28c1a97 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst @@ -0,0 +1,685 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_power_budget_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_power_budget -- Set power budget information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_power_budget`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set power budget information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ action + +
+ string +
+ 		+
    Choices: +
  • add
    • +
  • delete
    • +
  • open
    • +
  • close
    • +
+ 		+
Type to action.
+
Required when range=False.
+
+
+ domain + +
+ string +
+ 		+
    Choices: +
  • system
    • +
  • cpu
    • +
+ 		+
Domain id.
+
Required when range=False.
+
+
+ end1 + +
+ integer +
+ 		+ +
Pause period of add, end time, must be greater than start time, from 0 to 24.
+
+
+ end2 + +
+ integer +
+ 		+ +
Pause period of add, end time, must be greater than start time, from 0 to 24.
+
+
+ end3 + +
+ integer +
+ 		+ +
Pause period of add, end time, must be greater than start time, from 0 to 24.
+
+
+ end4 + +
+ integer +
+ 		+ +
Pause period of add, end time, must be greater than start time, from 0 to 24.
+
+
+ end5 + +
+ integer +
+ 		+ +
Pause period of add, end time, must be greater than start time, from 0 to 24.
+
+
+ except_action + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
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.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ id + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Policy id.
+
Required when range=False.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ range + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Range of power budget watts.
+
+
+ start1 + +
+ integer +
+ 		+ +
Pause period of add, start time, from 0 to 24.
+
+
+ start2 + +
+ integer +
+ 		+ +
Pause period of add, start time, from 0 to 24.
+
+
+ start3 + +
+ integer +
+ 		+ +
Pause period of add, start time, from 0 to 24.
+
+
+ start4 + +
+ integer +
+ 		+ +
Pause period of add, start time, from 0 to 24.
+
+
+ start5 + +
+ integer +
+ 		+ +
Period of add, start time, from 0 to 24.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ watts + +
+ integer +
+ 		+ +
Power budget watts of add.
+
Required when action=add.
+
+
+ week1 + +
+ list + / elements=string
+ 		+ +
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.
+
+
+ week2 + +
+ list + / elements=string
+ 		+ +
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.
+
+
+ week3 + +
+ list + / elements=string
+ 		+ +
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.
+
+
+ week4 + +
+ list + / elements=string
+ 		+ +
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.
+
+
+ week5 + +
+ list + / elements=string
+ 		+ +
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.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power budget test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power budget range" + kaytus.ksmanage.edit_power_budget: + range: True + provider: "{{ ksmanage }}" + + - name: "add power budget" + kaytus.ksmanage.edit_power_budget: + action: "add" + id: 1 + watts: 1500 + start1: 2 + end1: 5 + week1: + - Mon + - Wed + - Fri + provider: "{{ ksmanage }}" + + - name: "Set power budget status to open" + kaytus.ksmanage.edit_power_budget: + action: "open" + id: 1 + provider: "{{ ksmanage }}" + + - name: "Set power budget status to close" + kaytus.ksmanage.edit_power_budget: + action: "close" + id: 1 + provider: "{{ ksmanage }}" + + - name: "Delete power budget" + kaytus.ksmanage.edit_power_budget: + action: "delete" + id: 1 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst new file mode 100644 index 000000000..8a4fdfd77 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst @@ -0,0 +1,323 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_power_restore_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_power_restore -- Set power restore information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_power_restore`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set power restore information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ option + +
+ string + / required
+ 		+
    Choices: +
  • on
    • +
  • off
    • +
  • restore
    • +
+ 		+
Set power policy option.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power restore test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set power restore information" + kaytus.ksmanage.edit_power_restore: + option: "on" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst new file mode 100644 index 000000000..61d8ce18f --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst @@ -0,0 +1,325 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_power_status_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_power_status -- Set power status information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_power_status`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set power status information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ string + / required
+ 		+
    Choices: +
  • On
    • +
  • ForceOff
    • +
  • ForcePowerCycle
    • +
  • ForceReset
    • +
  • GracefulShutdown
    • +
+ 		+
Power status.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power status test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set power status information" + kaytus.ksmanage.edit_power_status: + state: "On" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst new file mode 100644 index 000000000..1cc0f8008 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst @@ -0,0 +1,373 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_preserve_config_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_preserve_config -- Set preserve config ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_preserve_config`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set preserve config on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ override + +
+ list + / elements=string
+ 		+
    Choices: +
  • authentication
    • +
  • dcmi
    • +
  • fru
    • +
  • hostname
    • +
  • ipmi
    • +
  • kvm
    • +
  • network
    • +
  • ntp
    • +
  • pef
    • +
  • sdr
    • +
  • sel
    • +
  • smtp
    • +
  • snmp
    • +
  • sol
    • +
  • ssh
    • +
  • syslog
    • +
  • user
    • +
+ 		+
Configuration items that need to be retained.
+
Required when setting=manual.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ setting + +
+ string + / required
+ 		+
    Choices: +
  • all
    • +
  • none
    • +
  • manual
    • +
+ 		+
Preserve option, all - preserve all config; none - overwrite all config; manual - manual choose.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Preserve test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set preserve all" + kaytus.ksmanage.edit_preserve_config: + setting: "all" + provider: "{{ ksmanage }}" + + - name: "Set preserve none" + edit_preserve_config: + setting: "none" + provider: "{{ ksmanage }}" + + - name: "Set preserve manual" + edit_preserve_config: + setting: "manual" + override: + - fru + - ntp + - network + - user + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst new file mode 100644 index 000000000..1466ceac0 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst @@ -0,0 +1,339 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_psu_config_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_psu_config -- Set psu config information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_psu_config`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set psu config information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ id + +
+ integer + / required
+ 		+ +
Power id.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ switch + +
+ string + / required
+ 		+
    Choices: +
  • active
    • +
  • standby
    • +
  • normal
    • +
+ 		+
Power supply mode, active or standby.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu config test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set psu config information" + kaytus.ksmanage.edit_psu_config: + id: 1 + switch: "active" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst new file mode 100644 index 000000000..d01632022 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst @@ -0,0 +1,343 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_psu_peak_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_psu_peak -- Set psu peak information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_psu_peak`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set psu peak information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ status + +
+ string + / required
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Power peak status.
+
+
+ time + +
+ integer +
+ 		+ +
Maximum random time, range of values(1-600), unit(second).
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu peak test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set psu peak information" + kaytus.ksmanage.edit_psu_peak: + status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set psu peak information" + kaytus.ksmanage.edit_psu_peak: + status: "enable" + time: 10 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst new file mode 100644 index 000000000..77ffa69e4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst @@ -0,0 +1,368 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_restore_factory_default_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_restore_factory_default -- Set preserver config +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_restore_factory_default`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set preserver config on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ mode + +
+ string + / required
+ 		+
    Choices: +
  • all
    • +
  • none
    • +
  • manual
    • +
+ 		+
Restore factory defaults mode.
+
+
+ override + +
+ list + / elements=string
+ 		+
    Choices: +
  • authentication
    • +
  • dcmi
    • +
  • fru
    • +
  • hostname
    • +
  • ipmi
    • +
  • kvm
    • +
  • network
    • +
  • ntp
    • +
  • pef
    • +
  • sdr
    • +
  • sel
    • +
  • smtp
    • +
  • snmp
    • +
  • sol
    • +
  • ssh
    • +
  • syslog
    • +
  • user
    • +
+ 		+
Configuration items that need to be retained.
+
Required when mode=manual.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Restore default test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set restore default auto" + kaytus.ksmanage.edit_restore_factory_default: + mode: "all" + provider: "{{ ksmanage }}" + + - name: "Set restore default manual" + kaytus.ksmanage.edit_restore_factory_default: + mode: "manual" + override: + - fru + - ntp + - network + - user + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst new file mode 100644 index 000000000..d5628c468 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst @@ -0,0 +1,428 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_service_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_service -- Set service settings +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_service`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set service settings on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface + +
+ string +
+ 		+
    Choices: +
  • eth0
    • +
  • eth1
    • +
  • both
    • +
  • bond0
    • +
+ 		+
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.
+
+
+ non_secure_port + +
+ integer +
+ 		+ +
Used to configure non secure port number for the service.
+
Port value ranges from 1 to 65535.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ secure_port + +
+ integer +
+ 		+ +
Used to configure secure port number for the service.
+
Port value ranges from 1 to 65535.
+
+
+ service_name + +
+ string + / required
+ 		+
    Choices: +
  • web
    • +
  • kvm
    • +
  • cd-media
    • +
  • fd-media
    • +
  • hd-media
    • +
  • ssh
    • +
  • telnet
    • +
  • solssh
    • +
  • snmp
    • +
  • vnc
    • +
+ 		+
Displays service name of the selected slot(readonly).
+
The vnc option is not supported in M5.
+
The fd-media/telnet/snmp option is not supported in M6.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • active
    • +
  • inactive
    • +
+ 		+
Displays the current status of the service, either active or inactive state.
+
Check this option to start the inactive service.
+
+
+ timeout + +
+ integer +
+ 		+ +
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.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Edit service test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Edit kvm" + kaytus.ksmanage.edit_service: + service_name: "kvm" + state: "active" + timeout: "1200" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst new file mode 100644 index 000000000..24f139729 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst @@ -0,0 +1,578 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_smtp_com_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_smtp_com -- Set SMTP information ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_smtp_com`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set SMTP com information on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ asset_tag + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Product asset label.
+
+
+ email + +
+ string +
+ 		+ +
Sender email.
+
+
+ event_level + +
+ string +
+ 		+
    Choices: +
  • Info
    • +
  • Warning
    • +
  • Critical
    • +
+ 		+
Events above this level will be sent.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ host_name + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Server name.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ serial_number + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Serial number.
+
+
+ server_auth + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SMTP server authentication.
+
+
+ server_ip + +
+ string +
+ 		+ +
SMTP server IP.
+
+
+ server_password + +
+ string +
+ 		+ +
SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).
+
Required when server_auth=enable.
+
+
+ server_port + +
+ integer +
+ 		+ +
SMTP server port, The Identification for retry count configuration(1-65535).
+
+
+ server_secure_port + +
+ integer +
+ 		+ +
SMTP server secure port, The Identification for retry count configuration(1-65535).
+
+
+ server_username + +
+ string +
+ 		+ +
SMTP server Username, length be 4 to 64 bits.
+
Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).
+
Required when server_auth=enable.
+
+
+ ssl_tls_enable + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SMTP SSLTLS Enable.
+
ssl_tls_enable=disable, when star_tls_enable=enable.
+
+
+ star_tls_enable + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SMTP STARTTLS Enable.
+
star_tls_enable=disable, when ssl_tls_enable=enable.
+
+
+ status + +
+ string + / required
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SMTP Support.
+
+
+ subject + +
+ string +
+ 		+ +
Email theme.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp com test + hosts: ksmanage + no_log: true + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp com information" + kaytus.ksmanage.edit_smtp_com: + status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set smtp com information" + kaytus.ksmanage.edit_smtp_com: + status: "enable" + server_ip: "100.2.2.2" + email: "ks@kaytus.com" + server_auth: "enable" + server_username: "admin" + server_password: "1234qwer!@#$" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst new file mode 100644 index 000000000..e2c403eb8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst @@ -0,0 +1,383 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_smtp_dest_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_smtp_dest -- Set SMTP information +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_smtp_dest`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set SMTP dest information on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ address + +
+ string +
+ 		+ +
Email address.
+
+
+ description + +
+ string +
+ 		+ +
Description information.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ id + +
+ integer + / required
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
Email destination id.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Email enable.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp dest test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp dest information" + kaytus.ksmanage.edit_smtp_dest: + id: 1 + status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set smtp dest information" + kaytus.ksmanage.edit_smtp_dest: + id: 1 + status: "enable" + address: "100.2.2.2" + description": "test" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst new file mode 100644 index 000000000..b00842ae8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst @@ -0,0 +1,587 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_smtp_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_smtp -- Set SMTP information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_smtp`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set SMTP information on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ email + +
+ string +
+ 		+ +
Sender email.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface + +
+ string + / required
+ 		+
    Choices: +
  • eth0
    • +
  • eth1
    • +
  • bond0
    • +
+ 		+
LAN Channel, eth0 is shared, eth1 is dedicated.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ primary_auth + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Primary SMTP server authentication.
+
+
+ primary_ip + +
+ string +
+ 		+ +
Primary SMTP server IP.
+
+
+ primary_name + +
+ string +
+ 		+ +
Primary SMTP server name.
+
+
+ primary_password + +
+ string +
+ 		+ +
Primary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).
+
Required when primary_auth=enable.
+
+
+ primary_port + +
+ integer +
+ 		+ +
Primary SMTP server port, The Identification for retry count configuration(1-65535).
+
+
+ primary_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Primary SMTP Support.
+
+
+ primary_username + +
+ string +
+ 		+ +
Primary SMTP server Username, length be 4 to 64 bits.
+
Must start with letters and cannot contain ', '(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ secondary_auth + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Secondary SMTP server authentication.
+
+
+ secondary_ip + +
+ string +
+ 		+ +
Secondary SMTP server IP.
+
+
+ secondary_name + +
+ string +
+ 		+ +
Secondary SMTP server name.
+
+
+ secondary_password + +
+ string +
+ 		+ +
Secondary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).
+
Required when secondary_auth=enable.
+
+
+ secondary_port + +
+ integer +
+ 		+ +
Secondary SMTP server port, The Identification for retry count configuration(1-65535).
+
+
+ secondary_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Secondary SMTP Support.
+
+
+ secondary_username + +
+ string +
+ 		+ +
Secondary SMTP server Username, length be 4 to 64 bits.
+
Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp test + hosts: ksmanage + no_log: true + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set smtp information" + kaytus.ksmanage.edit_smtp: + interface: "eth0" + email: "ieit@ieisystem.com" + primary_status: "enable" + primary_ip: "100.2.2.2" + primary_name: "test" + primary_auth: "disable" + provider: "{{ ksmanage }}" + + - name: "Set smtp information" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst new file mode 100644 index 000000000..d153a2fb1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst @@ -0,0 +1,540 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_snmp_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_snmp -- Set snmp ++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_snmp`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set snmp on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_password + +
+ string +
+ 		+ +
Set the authentication password for the V3 trap or v3get/v3set.
+
The password is a string of 8 to 16 alphanumeric characters.
+
Required when auth_protocol is either SHA or MD5.
+
+
+ auth_protocol + +
+ string +
+ 		+
    Choices: +
  • NONE
    • +
  • SHA
    • +
  • MD5
    • +
+ 		+
Choose the authentication protocol for the V3 trap or v3get/v3set.
+
+
+ community + +
+ string +
+ 		+ +
Community of v1/v2c or v1get/v1set/v2cget/v2cset.
+
Only the M5 models support this feature.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ priv_password + +
+ string +
+ 		+ +
Set the privacy password for the V3 trap or v3get/v3set.
+
The password is a string of 8 to 16 alphanumeric characters.
+
Required when priv_protocol is either DES or AES.
+
+
+ priv_protocol + +
+ string +
+ 		+
    Choices: +
  • NONE
    • +
  • DES
    • +
  • AES
    • +
+ 		+
Choose the privacy protocol for the V3 trap or v3get/v3set.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ read_community + +
+ string +
+ 		+ +
Read Only Community, Community should between 1 and 16 characters.
+
Only the M6 models support this feature.
+
+
+ read_write_community + +
+ string +
+ 		+ +
Read And Write Community, Community should between 1 and 16 characters.
+
Only the M6 models support this feature.
+
+
+ snmp_status + +
+ list + / elements=string
+ 		+ +
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.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ v1status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SNMP V1 enable.
+
+
+ v2status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SNMP V2 enable.
+
+
+ v3status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
SNMP V3 enable.
+
+
+ v3username + +
+ string +
+ 		+ +
Set a username for the V3 trap or v3get/v3set.
+
+
+ version + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
  • 4
    • +
+ 		+
SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.
+
Only the M5 models support this feature.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Snmp test + hosts: ksmanage + no_log: true + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set snmp get/set" + kaytus.ksmanage.edit_snmp: + community: "test" + v3username: "test" + provider: "{{ ksmanage }}" + + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst new file mode 100644 index 000000000..8efffc81a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst @@ -0,0 +1,598 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_snmp_trap_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_snmp_trap -- Set snmp trap ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_snmp_trap`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set snmp trap on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_password + +
+ string +
+ 		+ +
Set the authentication password for the V3 trap.
+
The password is a string of 8 to 16 alphanumeric characters.
+
Required when auth_protocol is either SHA or MD5.
+
+
+ auth_protocol + +
+ string +
+ 		+
    Choices: +
  • NONE
    • +
  • SHA
    • +
  • MD5
    • +
+ 		+
Choose the authentication protocol for the V3 trap.
+
+
+ community + +
+ string +
+ 		+ +
Community of v1/v2c.
+
+
+ contact + +
+ string +
+ 		+ +
Set the contact, can be NULL.
+
Only the M5 model supports this parameter.
+
+
+ engine_id + +
+ string +
+ 		+ +
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.
+
+
+ event_severity + +
+ string +
+ 		+
    Choices: +
  • all
    • +
  • warning
    • +
  • critical
    • +
+ 		+
Event Severity.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ host_id + +
+ string +
+ 		+
    Choices: +
  • HostName
    • +
  • SerialNum
    • +
  • AssertTag
    • +
+ 		+
Host id.
+
Only the M6 model supports this parameter.
+
+
+ location + +
+ string +
+ 		+ +
Set the host location, can be NULL.
+
Only the M5 model supports this parameter.
+
+
+ os + +
+ string +
+ 		+ +
Set the host operating system, can be NULL.
+
Only the M5 model supports this parameter.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ priv_password + +
+ string +
+ 		+ +
Set the privacy password for the V3 trap.
+
The password is a string of 8 to 16 alphanumeric characters.
+
Required when priv_protocol is either DES or AES.
+
+
+ priv_protocol + +
+ string +
+ 		+
    Choices: +
  • NONE
    • +
  • DES
    • +
  • AES
    • +
+ 		+
Choose the privacy protocol for the V3 trap.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ system_id + +
+ string +
+ 		+ +
Set the system ID, can be NULL.
+
Only the M5 model supports this parameter.
+
+
+ system_name + +
+ string +
+ 		+ +
Set the system name, can be NULL.
+
Only the M5 model supports this parameter.
+
+
+ trap_port + +
+ integer +
+ 		+ +
Set a port for the SNMP trap in the range of 1 to 65535.
+
Only the M5 model supports this parameter.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ v3username + +
+ string +
+ 		+ +
Set the username for the V3 trap.
+
+
+ version + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+ 		+
SNMP trap version, 1 is v1, 2 is v2c(v2), 3 is v3, 0 is disable snmp trap.
+
Only the M6 model supports 0 Settings.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Trap test + hosts: ksmanage + no_log: true + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set snmp trap v2c" + kaytus.ksmanage.edit_snmp_trap: + version: 2 + event_severity: "warning" + community: "test" + system_name: "ieisystem" + provider: "{{ ksmanage }}" + + - name: "Set snmp trap v3" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst new file mode 100644 index 000000000..b9aff43a0 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst @@ -0,0 +1,410 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_threshold_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_threshold -- Set threshold information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_threshold`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set threshold information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ lc + +
+ integer +
+ 		+ +
Lower critical threshold, should be integer.
+
+
+ lnc + +
+ integer +
+ 		+ +
Lower non critical threshold, should be integer.
+
+
+ lnr + +
+ integer +
+ 		+ +
Lower non recoverable threshold, should be integer.
+
+
+ name + +
+ string + / required
+ 		+ +
Sensor name.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ uc + +
+ integer +
+ 		+ +
Up critical threshold, should be integer.
+
+
+ unc + +
+ integer +
+ 		+ +
Up non critical threshold, should be integer.
+
+
+ unr + +
+ integer +
+ 		+ +
Up non recoverable threshold, should be integer.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Threshold test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set threshold information" + kaytus.ksmanage.edit_threshold: + name: "GPU1_Temp" + uc: 94 + unc: 92 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst new file mode 100644 index 000000000..7dbc0d87e --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst @@ -0,0 +1,343 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_uid_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_uid -- Set UID ++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_uid`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set UID on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ led + +
+ string + / required
+ 		+
    Choices: +
  • on
    • +
  • off
    • +
+ 		+
Turn on or turn off the led.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ time + +
+ integer +
+ 		+ +
Set led blink time(second).
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: UID test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set uid" + kaytus.ksmanage.edit_uid: + led: "on" + time: 10 + provider: "{{ ksmanage }}" + + - name: "Set uid" + kaytus.ksmanage.edit_uid: + led: "off" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst new file mode 100644 index 000000000..ae75b9534 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst @@ -0,0 +1,511 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_virtual_media_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_virtual_media -- Set virtual media ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_virtual_media`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set virtual media on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ local_media_support + +
+ string +
+ 		+
    Choices: +
  • Enable
    • +
  • Disable
    • +
+ 		+
To enable or disable Local Media Support, check or uncheck the checkbox respectively.
+
Only the M5 model supports this parameter.
+
+
+ mount + +
+ string +
+ 		+
    Choices: +
  • Enable
    • +
  • Disable
    • +
+ 		+
Whether to mount virtual media.
+
Only the M5 model supports this parameter.
+
+
+ mount_type + +
+ string +
+ 		+
    Choices: +
  • CD
    • +
  • FD
    • +
  • HD
    • +
+ 		+
Virtual mount type.
+
The FD option is not supported in M6.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ remote_domain_name + +
+ string +
+ 		+ +
Remote Domain Name, Domain Name field is optional.
+
+
+ remote_media_support + +
+ string +
+ 		+
    Choices: +
  • Enable
    • +
  • Disable
    • +
+ 		+
To enable or disable Remote Media support, check or uncheck the checkbox respectively.
+
+
+ remote_password + +
+ string +
+ 		+ +
Remote Password.
+
Required when remote_share_type=cifs.
+
+
+ remote_server_address + +
+ string +
+ 		+ +
Address of the server where the remote media images are stored.
+
+
+ remote_share_type + +
+ string +
+ 		+
    Choices: +
  • nfs
    • +
  • cifs
    • +
+ 		+
Share Type of the remote media server either NFS or Samba(CIFS).
+
+
+ remote_source_path + +
+ string +
+ 		+ +
Source path to the remote media images..
+
+
+ remote_user_name + +
+ string +
+ 		+ +
Remote User Name.
+
Required when remote_share_type=cifs.
+
+
+ same_settings + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
+ 		+
Same settings with CD, 0 is No, 1 is Yes.
+
Required when mount_type=0.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media test + hosts: ksmanage + no_log: true + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set local media" + kaytus.ksmanage.edit_virtual_media: + local_media_support: "Enable" + provider: "{{ ksmanage }}" + + - name: "Set remote media" + kaytus.ksmanage.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: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst new file mode 100644 index 000000000..de8697253 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst @@ -0,0 +1,381 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.edit_vlan_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.edit_vlan -- Set vlan information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_vlan`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Set vlan information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ interface_name + +
+ string + / required
+ 		+
    Choices: +
  • eth0
    • +
  • eth1
    • +
  • bond0
    • +
+ 		+
Set interface name. Select the LAN interface to be configured.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ vlan_id + +
+ integer +
+ 		+ +
The Identification for VLAN configuration(2-4094).
+
+
+ vlan_priority + +
+ integer +
+ 		+ +
The priority for VLAN configuration(1-7).
+
+
+ vlan_status + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable or disable vlan.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Vlan test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Set vlan information" + kaytus.ksmanage.edit_vlan: + interface_name: "eth0" + vlan_status: "disable" + provider: "{{ ksmanage }}" + + - name: "Set vlan information" + kaytus.ksmanage.edit_vlan: + interface_name: "eth0" + vlan_status: "enable" + vlan_id: 2 + vlan_priority: 1 + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst new file mode 100644 index 000000000..f044fa131 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst @@ -0,0 +1,358 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.event_log_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.event_log_info -- Get event log information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.event_log_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get event log information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ +
Get the most recent log of a specified number.
+
+
+ event_file + +
+ string +
+ 		+ +
Store logs to a file.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ log_time + +
+ string +
+ 		+ +
Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Event log info test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get event log information" + kaytus.ksmanage.event_log_info: + log_time: "2020-06-01T12:30+08:00" + provider: "{{ ksmanage }}" + + - name: "Get event log information" + kaytus.ksmanage.event_log_info: + count: 30 + provider: "{{ ksmanage }}" + + - name: "Get event log information" + kaytus.ksmanage.event_log_info: + event_file: "/home/wbs/wbs.log" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst new file mode 100644 index 000000000..15f9eabb4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.event_log_policy_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.event_log_policy_info -- Get event log policy information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.event_log_policy_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get event log policy information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Event log policy test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get event log policy information" + kaytus.ksmanage.event_log_policy_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst new file mode 100644 index 000000000..e6312749b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.fan_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.fan_info -- Get fan information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.fan_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get fan information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fan test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get fan information" + kaytus.ksmanage.fan_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst new file mode 100644 index 000000000..d6cb650ad --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.fru_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.fru_info -- Get fru information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.fru_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get fru information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Fru info test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get fru information" + kaytus.ksmanage.fru_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst new file mode 100644 index 000000000..249c9960a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.fw_version_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.fw_version_info -- Get firmware version information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.fw_version_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get firmware version information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Firmware version test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get firmware version information" + kaytus.ksmanage.fw_version_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst new file mode 100644 index 000000000..cbef0cd68 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst @@ -0,0 +1,303 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.gpu_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.gpu_info -- Get GPU information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.gpu_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get GPU information on kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: GPU test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get gpu information" + kaytus.ksmanage.gpu_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst new file mode 100644 index 000000000..0e3c61bdb --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.hard_disk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.hard_disk_info -- Get hard disk information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.hard_disk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get hard disk information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Hard disk test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get hard disk information" + kaytus.ksmanage.hard_disk_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst new file mode 100644 index 000000000..da2f90f34 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.hba_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.hba_info -- Get CPU information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.hba_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get HBA information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: HBA test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get hba information" + kaytus.ksmanage.hba_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/index.rst b/ansible_collections/kaytus/ksmanage/docs/index.rst new file mode 100644 index 000000000..5f7e2fcf8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/index.rst @@ -0,0 +1,149 @@ +:orphan: + +.. _plugins_in_kaytus.ksmanage: + +Plugin Index +============ + +These are the plugins in the kaytus.ksmanage collection + +.. toctree:: + :maxdepth: 1 + + +Modules +------- + +* :ref:`ad_group ` -- Manage active directory group information +* :ref:`ad_group_info ` -- Get active directory group information +* :ref:`ad_info ` -- Get active directory information +* :ref:`adapter_info ` -- Get adapter information +* :ref:`add_ldisk ` -- Create logical disk +* :ref:`alert_policy_info ` -- Get alert policy +* :ref:`audit_log_info ` -- Get BMC audit log information +* :ref:`auto_capture_info ` -- Get auto capture screen information +* :ref:`backplane_info ` -- Get disk backplane information +* :ref:`backup ` -- Backup server settings +* :ref:`bios_export ` -- Export BIOS config +* :ref:`bios_import ` -- Import BIOS config +* :ref:`bios_info ` -- Get BIOS setup +* :ref:`bmc_info ` -- Get BMC information +* :ref:`boot_image_info ` -- Get bmc boot image information +* :ref:`boot_option_info ` -- Get BIOS boot options +* :ref:`clear_audit_log ` -- Clear BMC audit log +* :ref:`clear_event_log ` -- Clear event log +* :ref:`clear_system_log ` -- Clear BMC system log +* :ref:`collect_blackbox ` -- Collect blackbox log +* :ref:`collect_log ` -- Collect logs +* :ref:`connect_media_info ` -- Get remote images redirection information +* :ref:`cpu_info ` -- Get CPU information +* :ref:`del_session ` -- Delete session +* :ref:`dns_info ` -- Get dns information +* :ref:`download_auto_screenshot ` -- Download auto screenshots +* :ref:`download_manual_screenshot ` -- Download manual screenshots +* :ref:`edit_ad ` -- Set active directory information +* :ref:`edit_alert_policy ` -- Set alert policy +* :ref:`edit_auto_capture ` -- Set auto capture screen +* :ref:`edit_bios ` -- Set BIOS setup attributes +* :ref:`edit_boot_image ` -- Set bmc boot image +* :ref:`edit_boot_option ` -- Set BIOS boot options +* :ref:`edit_connect_media ` -- Start/Stop virtual media Image +* :ref:`edit_dns ` -- Set dns information +* :ref:`edit_event_log_policy ` -- Set event log policy +* :ref:`edit_fan ` -- Set fan information +* :ref:`edit_fru ` -- Set fru settings +* :ref:`edit_ipv4 ` -- Set ipv4 information +* :ref:`edit_ipv6 ` -- Set ipv6 information +* :ref:`edit_kvm ` -- Set KVM +* :ref:`edit_ldap ` -- Set ldap information +* :ref:`edit_ldisk ` -- Set logical disk +* :ref:`edit_log_setting ` -- Set bmc system and audit log setting +* :ref:`edit_m6_log_setting ` -- Set bmc system and audit log setting +* :ref:`edit_manual_capture ` -- Set manual capture screen +* :ref:`edit_media_instance ` -- Set Virtual Media Instance +* :ref:`edit_ncsi ` -- Set ncsi information +* :ref:`edit_network ` -- Set network information +* :ref:`edit_network_bond ` -- Set network bond +* :ref:`edit_network_link ` -- Set network link +* :ref:`edit_ntp ` -- Set NTP +* :ref:`edit_pdisk ` -- Set physical disk +* :ref:`edit_power_budget ` -- Set power budget information +* :ref:`edit_power_restore ` -- Set power restore information +* :ref:`edit_power_status ` -- Set power status information +* :ref:`edit_preserve_config ` -- Set preserve config +* :ref:`edit_psu_config ` -- Set psu config information +* :ref:`edit_psu_peak ` -- Set psu peak information +* :ref:`edit_restore_factory_default ` -- Set preserver config +* :ref:`edit_service ` -- Set service settings +* :ref:`edit_smtp ` -- Set SMTP information +* :ref:`edit_smtp_com ` -- Set SMTP information +* :ref:`edit_smtp_dest ` -- Set SMTP information +* :ref:`edit_snmp ` -- Set snmp +* :ref:`edit_snmp_trap ` -- Set snmp trap +* :ref:`edit_threshold ` -- Set threshold information +* :ref:`edit_uid ` -- Set UID +* :ref:`edit_virtual_media ` -- Set virtual media +* :ref:`edit_vlan ` -- Set vlan information +* :ref:`event_log_info ` -- Get event log information +* :ref:`event_log_policy_info ` -- Get event log policy information +* :ref:`fan_info ` -- Get fan information +* :ref:`fru_info ` -- Get fru information +* :ref:`fw_version_info ` -- Get firmware version information +* :ref:`gpu_info ` -- Get GPU information +* :ref:`hard_disk_info ` -- Get hard disk information +* :ref:`hba_info ` -- Get CPU information +* :ref:`kvm_info ` -- Get KVM information +* :ref:`ldap_group ` -- Manage ldap group information +* :ref:`ldap_group_info ` -- Get ldap group information +* :ref:`ldap_info ` -- Get ldap information +* :ref:`ldisk_info ` -- Get logical disks information +* :ref:`log_setting_info ` -- Get bmc log setting information +* :ref:`media_instance_info ` -- Get Virtual Media Instance information +* :ref:`mem_info ` -- Get memory information +* :ref:`ncsi_info ` -- Get ncsi information +* :ref:`network_bond_info ` -- Get network bond information +* :ref:`network_info ` -- Get network information +* :ref:`network_link_info ` -- Get network link information +* :ref:`ntp_info ` -- Get NTP information +* :ref:`onboard_disk_info ` -- Get onboard disks information +* :ref:`pcie_info ` -- Get PCIE information +* :ref:`pdisk_info ` -- Get physical disks information +* :ref:`power_budget_info ` -- Get power budget information +* :ref:`power_consumption_info ` -- Get power consumption information +* :ref:`power_restore_info ` -- Get power restore information +* :ref:`power_status_info ` -- Get power status information +* :ref:`preserve_config_info ` -- Get preserve config information +* :ref:`psu_config_info ` -- Get psu config information +* :ref:`psu_info ` -- Get psu information +* :ref:`psu_peak_info ` -- Get psu peak information +* :ref:`raid_info ` -- Get RAID/HBA card and controller information +* :ref:`reset_bmc ` -- BMC reset +* :ref:`reset_kvm ` -- KVM reset +* :ref:`restore ` -- Restore server settings +* :ref:`self_test_info ` -- Get self test information +* :ref:`sensor_info ` -- Get sensor information +* :ref:`server_info ` -- Get server status information +* :ref:`service_info ` -- Get service information +* :ref:`session_info ` -- Get online session information +* :ref:`smtp_info ` -- Get SMTP information +* :ref:`snmp_info ` -- Get snmp get/set information +* :ref:`snmp_trap_info ` -- Get snmp trap information +* :ref:`support_info ` -- Get support information +* :ref:`system_log_info ` -- Get BMC system log information +* :ref:`temp_info ` -- Get temp information +* :ref:`threshold_info ` -- Get threshold information +* :ref:`uid_info ` -- Get UID information +* :ref:`update_cpld ` -- Update CPLD +* :ref:`update_fw ` -- Update firmware +* :ref:`update_psu ` -- Update PSU +* :ref:`user ` -- Manage user +* :ref:`user_group ` -- Manage user group +* :ref:`user_group_info ` -- Get user group information +* :ref:`user_info ` -- Get user information +* :ref:`virtual_media_info ` -- Get Virtual Media information +* :ref:`volt_info ` -- Get volt information + + +.. seealso:: + + List of :ref:`collections ` with docs hosted here. \ No newline at end of file diff --git a/ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst new file mode 100644 index 000000000..d49a4419d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.kvm_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.kvm_info -- Get KVM information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.kvm_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get KVM information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: KVM test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get KVM information" + kaytus.ksmanage.kvm_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst new file mode 100644 index 000000000..b9547b613 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ldap_group_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ldap_group_info -- Get ldap group information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ldap_group_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get ldap group information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap group test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ldap group information" + kaytus.ksmanage.ldap_group_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst new file mode 100644 index 000000000..11bb506fe --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst @@ -0,0 +1,431 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ldap_group_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ldap_group -- Manage ldap group information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ldap_group`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage ldap group information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ base + +
+ string +
+ 		+ +
Search Base.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ kvm + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Kvm privilege.
+
+
+ name + +
+ string + / required
+ 		+ +
Group name.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ pri + +
+ string +
+ 		+
    Choices: +
  • administrator
    • +
  • user
    • +
  • operator
    • +
  • oem
    • +
  • none
    • +
+ 		+
Group privilege.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Whether the ldap group should exist or not, taking action if the state is different from what is stated.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ vm + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Vmedia privilege.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap group test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add ldap group information" + kaytus.ksmanage.ldap_group: + state: "present" + name: "wbs" + base: "cn=manager" + pri: "administrator" + kvm: "enable" + vm: "disable" + provider: "{{ ksmanage }}" + + - name: "Set ldap group information" + kaytus.ksmanage.ldap_group: + state: "present" + name: "wbs" + pri: "user" + kvm: "disable" + provider: "{{ ksmanage }}" + + - name: "Delete ldap group information" + kaytus.ksmanage.ldap_group: + state: "absent" + name: "wbs" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst new file mode 100644 index 000000000..ff3930935 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ldap_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ldap_info -- Get ldap information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ldap_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get ldap information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldap test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ldap information" + kaytus.ksmanage.ldap_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst new file mode 100644 index 000000000..5bdc084f4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ldisk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ldisk_info -- Get logical disks information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ldisk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get logical disks information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Ldisk test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get logical disks information" + kaytus.ksmanage.ldisk_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst new file mode 100644 index 000000000..8ee414a37 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.log_setting_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.log_setting_info -- Get bmc log setting information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.log_setting_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get bmc log setting information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc log setting test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc log setting information" + kaytus.ksmanage.log_setting_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst new file mode 100644 index 000000000..526996e24 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.media_instance_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.media_instance_info -- Get Virtual Media Instance information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.media_instance_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get Virtual Media Instance information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media instance test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get Virtual Media Instance information" + kaytus.ksmanage.media_instance_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst new file mode 100644 index 000000000..2eec9089b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.mem_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.mem_info -- Get memory information +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.mem_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get memory information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Memory test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get memory information" + kaytus.ksmanage.mem_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst new file mode 100644 index 000000000..02f5968e3 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ncsi_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ncsi_info -- Get ncsi information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ncsi_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get ncsi information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NCSI test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ncsi information" + kaytus.ksmanage.ncsi_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst new file mode 100644 index 000000000..982b0cd3a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.network_bond_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.network_bond_info -- Get network bond information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.network_bond_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get network bond information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bond test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network bond information" + kaytus.ksmanage.network_bond_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/network_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/network_info_module.rst new file mode 100644 index 000000000..18f60a34e --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/network_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.network_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.network_info -- Get network information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.network_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get network information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Network test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network information" + kaytus.ksmanage.network_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst new file mode 100644 index 000000000..1eee30569 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.network_link_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.network_link_info -- Get network link information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.network_link_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get network link information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Link test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get network link information" + kaytus.ksmanage.network_link_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst new file mode 100644 index 000000000..3afae3bb7 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.ntp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.ntp_info -- Get NTP information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.ntp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get NTP information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: NTP test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get ntp information" + kaytus.ksmanage.ntp_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst new file mode 100644 index 000000000..d1b0492f4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.onboard_disk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.onboard_disk_info -- Get onboard disks information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.onboard_disk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get onboard disks information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Onboard test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get onboard disks information" + kaytus.ksmanage.onboard_disk_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst new file mode 100644 index 000000000..703295de1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.pcie_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.pcie_info -- Get PCIE information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.pcie_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get PCIE information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: PCIE test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get PCIE information" + kaytus.ksmanage.pcie_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst new file mode 100644 index 000000000..833e99678 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.pdisk_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.pdisk_info -- Get physical disks information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.pdisk_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get physical disks information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Pdisk test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get physical disks information" + kaytus.ksmanage.pdisk_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst new file mode 100644 index 000000000..f5b67925a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.power_budget_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.power_budget_info -- Get power budget information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.power_budget_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power budget information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power budget test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power budget information" + kaytus.ksmanage.power_budget_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst new file mode 100644 index 000000000..93100b023 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.power_consumption_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.power_consumption_info -- Get power consumption information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.power_consumption_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power consumption information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power consumption test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power consumption information" + kaytus.ksmanage.power_consumption_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst new file mode 100644 index 000000000..4e2cef249 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.power_restore_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.power_restore_info -- Get power restore information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.power_restore_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power restore information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power restore test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power restore information" + kaytus.ksmanage.power_restore_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst new file mode 100644 index 000000000..ca0ada784 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.power_status_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.power_status_info -- Get power status information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.power_status_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get power status information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Power status test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get power status information" + kaytus.ksmanage.power_status_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst new file mode 100644 index 000000000..4355044d9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.preserve_config_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.preserve_config_info -- Get preserve config information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.preserve_config_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get preserve config information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Preserve test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get preserve config information" + kaytus.ksmanage.preserve_config_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst new file mode 100644 index 000000000..edd7f62d1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.psu_config_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.psu_config_info -- Get psu config information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.psu_config_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get psu config information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu config test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu config information" + kaytus.ksmanage.psu_config_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst new file mode 100644 index 000000000..e38da43b9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.psu_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.psu_info -- Get psu information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.psu_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get psu information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu information" + kaytus.ksmanage.psu_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst new file mode 100644 index 000000000..01872cdb8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.psu_peak_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.psu_peak_info -- Get psu peak information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.psu_peak_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get psu peak information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Psu peak test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get psu peak information" + kaytus.ksmanage.psu_peak_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst new file mode 100644 index 000000000..83dc91897 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.raid_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.raid_info -- Get RAID/HBA card and controller information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.raid_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get RAID/HBA card and controller information information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Raid test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get raid information" + kaytus.ksmanage.raid_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst b/ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst new file mode 100644 index 000000000..538de2f47 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.reset_bmc_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.reset_bmc -- BMC reset +++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.reset_bmc`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- BMC reset on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Reset bmc test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Reset bmc" + kaytus.ksmanage.reset_bmc: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst b/ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst new file mode 100644 index 000000000..5feacf138 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.reset_kvm_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.reset_kvm -- KVM reset +++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.reset_kvm`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- KVM reset on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Reset kvm test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Reset kvm" + kaytus.ksmanage.reset_kvm: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/restore_module.rst b/ansible_collections/kaytus/ksmanage/docs/restore_module.rst new file mode 100644 index 000000000..126a6ee82 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/restore_module.rst @@ -0,0 +1,348 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.restore_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.restore -- Restore server settings +++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.restore`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Restore server settings on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bak_file + +
+ string + / required
+ 		+ +
Select backup file or bak folder.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ item + +
+ string +
+ 		+
    Choices: +
  • all
    • +
  • network
    • +
  • dns
    • +
  • service
    • +
  • ntp
    • +
  • smtp
    • +
  • snmptrap
    • +
  • ad
    • +
  • ldap
    • +
  • user
    • +
  • bios
    • +
+ 		+
Select export item.
+
Only the M5 model supports this parameter.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Restore test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Restore server settings" + kaytus.ksmanage.restore: + bak_file: "/home/wbs/backfile" + item: "all" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst new file mode 100644 index 000000000..1d862de9b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.self_test_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.self_test_info -- Get self test information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.self_test_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get self test information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Self test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get self test information" + kaytus.ksmanage.self_test_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst new file mode 100644 index 000000000..23e916893 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.sensor_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.sensor_info -- Get sensor information ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.sensor_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get sensor information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Sensor test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get sensor information" + kaytus.ksmanage.sensor_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/server_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/server_info_module.rst new file mode 100644 index 000000000..00af7471a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/server_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.server_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.server_info -- Get server status information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.server_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get server status information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Server test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get server status information" + kaytus.ksmanage.server_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/service_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/service_info_module.rst new file mode 100644 index 000000000..044882ccb --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/service_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.service_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.service_info -- Get service information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.service_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get service information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Service info test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get service information" + kaytus.ksmanage.service_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/session_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/session_info_module.rst new file mode 100644 index 000000000..bbbfc7b83 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/session_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.session_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.session_info -- Get online session information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.session_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get online session information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Session test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get session information" + kaytus.ksmanage.session_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst new file mode 100644 index 000000000..e60b7590d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.smtp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.smtp_info -- Get SMTP information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.smtp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get SMTP information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Smtp test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get smtp information" + kaytus.ksmanage.smtp_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst new file mode 100644 index 000000000..10fdfeebc --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.snmp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.snmp_info -- Get snmp get/set information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.snmp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get snmp get/set information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Snmp test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get snmp get/set information" + kaytus.ksmanage.snmp_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst new file mode 100644 index 000000000..b20b0c406 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.snmp_trap_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.snmp_trap_info -- Get snmp trap information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.snmp_trap_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get snmp trap information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Trap test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get snmp trap information" + kaytus.ksmanage.snmp_trap_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/support_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/support_info_module.rst new file mode 100644 index 000000000..48f5b4e19 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/support_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.support_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.support_info -- Get support information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.support_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get the kaytus 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Support list test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get support information" + kaytus.ksmanage.support_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst new file mode 100644 index 000000000..f32d734bd --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst @@ -0,0 +1,384 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.system_log_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.system_log_info -- Get BMC system log information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.system_log_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get BMC system log information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ +
Get the most recent log of a specified number.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • alert ←
    • +
  • critical
    • +
  • error
    • +
  • notice
    • +
  • warning
    • +
  • debug
    • +
  • emergency
    • +
  • info
    • +
+ 		+
Log level.
+
+
+ log_time + +
+ string +
+ 		+ +
Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ system_file + +
+ string +
+ 		+ +
Store logs to a file.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Bmc system log info test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get bmc system log information" + kaytus.ksmanage.system_log_info: + level: "alert" + log_time: "2020-06-01T12:30+08:00" + provider: "{{ ksmanage }}" + + - name: "Get bmc system log information" + kaytus.ksmanage.system_log_info: + count: 30 + provider: "{{ ksmanage }}" + + - name: "Get bmc system log information" + kaytus.ksmanage.system_log_info: + system_file: "/home/wbs/wbs.log" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst new file mode 100644 index 000000000..5e002df4f --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.temp_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.temp_info -- Get temp information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.temp_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get temp information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Temp test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get temp information" + kaytus.ksmanage.temp_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst new file mode 100644 index 000000000..0b8d36530 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.threshold_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.threshold_info -- Get threshold information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.threshold_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get threshold information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Threshold test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get threshold information" + kaytus.ksmanage.threshold_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst new file mode 100644 index 000000000..cdd209e86 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.uid_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.uid_info -- Get UID information ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.uid_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get UID information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: UID test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get UID information" + kaytus.ksmanage.uid_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst b/ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst new file mode 100644 index 000000000..9bff7c976 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst @@ -0,0 +1,362 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.update_cpld_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.update_cpld -- Update CPLD +++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.update_cpld`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Update CPLD on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ file_url + +
+ string +
+ 		+ +
CPLD image file path.
+
Required when list=False.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ id + +
+ integer +
+ 		+ +
CPLD id.
+
Required when list=False.
+
Only the M5 model supports this parameter.
+
+
+ list + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Get cpld list.
+
Only the M5 model supports this parameter.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: CPLD test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get cpld list" + kaytus.ksmanage.update_cpld: + list: True + provider: "{{ ksmanage }}" + + - name: "Update cpld" + update_cpld: + id: 1 + file_url: "home/wbs/raw.bin" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst b/ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst new file mode 100644 index 000000000..be678438f --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst @@ -0,0 +1,426 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.update_fw_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.update_fw -- Update firmware +++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.update_fw`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Update firmware on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ dual_image + +
+ string +
+ 		+
    Choices: +
  • single
    • +
  • dual ←
    • +
+ 		+
Update dual image(default) or not.
+
Only the M5 model supports this parameter.
+
+
+ has_me + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
+ Default:
1
+ 		+
Update me or not when update bios, only work in INTEL platform, 0-no, 1-yes.
+
Only the M5 model supports this parameter.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • Auto ←
    • +
  • Manual
    • +
+ 		+
Active mode, Manual or Auto(default).
+
+
+ over_ride + +
+ integer +
+ 		+
    Choices: +
  • 0
    • +
  • 1
    • +
+ Default:
0
+ 		+
Reserve Configurations, 0-reserve, 1-override.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ type + +
+ string +
+ 		+
    Choices: +
  • BMC
    • +
  • BIOS
    • +
+ 		+
Firmware type.
+
+
+ url + +
+ string + / required
+ 		+ +
Firmware image url.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Update fw test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "update bios" + kaytus.ksmanage.update_fw: + url: "/home/wbs/SA5112M5_BIOS_4.1.8_Standard_20200117.bin" + type: "BIOS" + provider: "{{ ksmanage }}" + + - name: "update bmc" + kaytus.ksmanage.update_fw: + url: "/home/wbs/SA5112M5_BMC_4.17.7_Standard_20200430" + mode: "Auto" + type: "BMC" + dual_image: "dual" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst b/ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst new file mode 100644 index 000000000..401f33041 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst @@ -0,0 +1,338 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.update_psu_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.update_psu -- Update PSU +++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.update_psu`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Update psu on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • Auto ←
    • +
  • Manual
    • +
+ 		+
Server Auto Reset Option, Manual or Auto(default).
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ url + +
+ string + / required
+ 		+ +
Firmware image url.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Update psu test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "update psu" + kaytus.ksmanage.update_psu: + url: "/home/wbs/CRPS1300D2W_00.01.04_BootLoader_Pri_Sec.hpm" + mode: "Auto" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst new file mode 100644 index 000000000..3272be892 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.user_group_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.user_group_info -- Get user group information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.user_group_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get user group information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User group test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get user group information" + kaytus.ksmanage.user_group_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/user_group_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_group_module.rst new file mode 100644 index 000000000..e92cf95bd --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_group_module.rst @@ -0,0 +1,532 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.user_group_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.user_group -- Manage user group ++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.user_group`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage user group on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ debug + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Debug diagnose privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ general + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
General configuration privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ kvm + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Remote KVM configuration privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ media + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Remote media configuration privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ name + +
+ string + / required
+ 		+ +
Group name.
+
The range of group name for M6 model is OEM1, OEM2, OEM3, OEM4.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ power + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Power control privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ pri + +
+ string +
+ 		+
    Choices: +
  • administrator
    • +
  • operator
    • +
  • user
    • +
  • oem
    • +
  • none
    • +
+ 		+
Group privilege.
+
Required when state=present.
+
Only the M5 model supports this parameter.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ security + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Security configuration privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ self + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Itself configuration privilege.
+
Required when state=present.
+
Only the M6 model supports this parameter.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Whether the user group should exist or not, taking action if the state is different from what is stated.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User group test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add user group" + kaytus.ksmanage.user_group: + state: "present" + name: "test" + pri: "administrator" + provider: "{{ ksmanage }}" + + - name: "Set user group" + kaytus.ksmanage.user_group: + state: "present" + name: "test" + pri: "user" + provider: "{{ ksmanage }}" + + - name: "Set m6 user group" + kaytus.ksmanage.user_group: + state: "present" + name: "OEM1" + general: "enable" + kvm: "enable" + provider: "{{ ksmanage }}" + + - name: "Delete user group" + kaytus.ksmanage.user_group: + state: "absent" + name: "test" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/user_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_info_module.rst new file mode 100644 index 000000000..747573924 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.user_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.user_info -- Get user information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.user_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get user information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get user information" + kaytus.ksmanage.user_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/user_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_module.rst new file mode 100644 index 000000000..9b0fd6d77 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_module.rst @@ -0,0 +1,454 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.user_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.user -- Manage user ++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.user`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Manage user on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
User access.
+
+
+ email + +
+ string +
+ 		+ +
User email.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ priv + +
+ list + / elements=string
+ 		+
    Choices: +
  • kvm
    • +
  • vmm
    • +
  • sol
    • +
  • none
    • +
+ 		+
Other user permissions, select one or more from None/KVM/VMM/SOL.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ role_id + +
+ string +
+ 		+ +
User group.
+
Default user group 'Administrator', 'Operator', 'User'.
+
Use command user_group_info can get all group information.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Whether the user should exist or not, taking action if the state is different from what is stated.
+
+
+ uid + +
+ integer +
+ 		+ +
User id, The range is 1 to 16.
+
+
+ uname + +
+ string +
+ 		+ +
User name, Required when uid is None.
+
+
+ upass + +
+ string +
+ 		+ +
User password.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: User test + hosts: ksmanage + no_log: true + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Add user" + kaytus.ksmanage.user: + state: "present" + uname: "wbs" + upass: "admin" + role_id: "Administrator" + priv: "kvm, sol" + email: "wbs@ieisystem.com" + provider: "{{ ksmanage }}" + + - name: "Set user" + kaytus.ksmanage.user: + state: "present" + uname: "wbs" + upass: "12345678" + role_id: "user" + priv: "kvm, sol" + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst new file mode 100644 index 000000000..5042af089 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.virtual_media_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.virtual_media_info -- Get Virtual Media information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.virtual_media_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get Virtual Media information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Media test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get Virtual Media information" + kaytus.ksmanage.virtual_media_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + diff --git a/ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst new file mode 100644 index 000000000..59f5139be --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.kaytus.ksmanage.volt_info_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +kaytus.ksmanage.volt_info -- Get volt information ++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `kaytus.ksmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`. + + To use it in a playbook, specify: :code:`kaytus.ksmanage.volt_info`. + +.. version_added + +.. versionadded:: 1.0.0 of kaytus.ksmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Get volt information on kaytus Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Supports ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Volt test + hosts: ksmanage + connection: local + gather_facts: false + vars: + ksmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Get volt information" + kaytus.ksmanage.volt_info: + provider: "{{ ksmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + -- cgit v1.2.3