diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:18:41 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:18:41 +0000 |
| commit | b643c52cf29ce5bbab738b43290af3556efa1ca9 (patch) | |
| tree | 21d5c53d7a9b696627a255777cefdf6f78968824 /ansible_collections/dellemc/openmanage/docs | |
| parent | Releasing progress-linux version 9.5.1+dfsg-1~progress7.99u1. (diff) | |
| download | ansible-b643c52cf29ce5bbab738b43290af3556efa1ca9.tar.xz ansible-b643c52cf29ce5bbab738b43290af3556efa1ca9.zip | |
Merging upstream version 10.0.0+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/dellemc/openmanage/docs')
12 files changed, 1205 insertions, 204 deletions
diff --git a/ansible_collections/dellemc/openmanage/docs/ATTRIBUTION.md b/ansible_collections/dellemc/openmanage/docs/ATTRIBUTION.md new file mode 100644 index 000000000..969a2d706 --- /dev/null +++ b/ansible_collections/dellemc/openmanage/docs/ATTRIBUTION.md @@ -0,0 +1,27 @@ +OpenSource Licenses for Dell OpenManage Ansible Modules +======================================================================= + +*** +Package: xorriso +Version: v1.5.6 +Copyright: Copyright © 2008 - 2022 Thomas Schmitt. +License: [GPL version 3 or later](https://www.gnu.org/software/xorriso/) + +*** +Package: syslinux +Version: v6.04 +Copyright: Copyright 1994-2011 H. Peter Anvin et al - All Rights Reserved +License: [GPL-2.0 license or later](https://repo.or.cz/syslinux.git) + +*** +Package: isomd5sum +Version: v1.2.3 +License: [GPL-2.0 license](https://github.com/rhinstaller/isomd5sum) + +*** +Package: wget +Version: v1.21.4 +Copyright: Copyright © 2017 Free Software Foundation, Inc. +License: [GNU General Public License](https://www.gnu.org/software/wget/) + +***
\ No newline at end of file diff --git a/ansible_collections/dellemc/openmanage/docs/EXECUTION_ENVIRONMENT.md b/ansible_collections/dellemc/openmanage/docs/EXECUTION_ENVIRONMENT.md index c5f556a72..fc5d0fff7 100644 --- a/ansible_collections/dellemc/openmanage/docs/EXECUTION_ENVIRONMENT.md +++ b/ansible_collections/dellemc/openmanage/docs/EXECUTION_ENVIRONMENT.md @@ -58,7 +58,6 @@ Build a image with the required Ansible collections and libraries, and then uplo ```yaml omsdk netaddr>=0.7.19 - jmespath ``` Note: The content of the *requirements.txt* can be found [here](https://github.com/dell/dellemc-openmanage-ansible-modules/blob/collections/requirements.txt) diff --git a/ansible_collections/dellemc/openmanage/docs/README.md b/ansible_collections/dellemc/openmanage/docs/README.md index 4f39dbc96..58c1d50fe 100644 --- a/ansible_collections/dellemc/openmanage/docs/README.md +++ b/ansible_collections/dellemc/openmanage/docs/README.md @@ -10,94 +10,103 @@ You may obtain a copy of the License at # OpenManage Ansible Modules Documentation ### iDRAC Modules -- [dellemc_configure_idrac_eventing](modules/dellemc_configure_idrac_eventing.rst) -- [dellemc_configure_idrac_services](modules/dellemc_configure_idrac_services.rst) -- [dellemc_idrac_lc_attributes](modules/dellemc_idrac_lc_attributes.rst) -- [dellemc_idrac_storage_volume](modules/dellemc_idrac_storage_volume.rst) -- [dellemc_system_lockdown_mode](modules/dellemc_system_lockdown_mode.rst) -- [idrac_attributes](modules/idrac_attributes.rst) -- [idrac_bios](modules/idrac_bios.rst) -- [idrac_boot](modules/idrac_boot.rst) -- [idrac_certificates](modules/idrac_certificates.rst) -- [idrac_firmware](modules/idrac_firmware.rst) -- [idrac_firmware_info](modules/idrac_firmware_info.rst) -- [idrac_lifecycle_controller_jobs](modules/idrac_lifecycle_controller_jobs.rst) -- [idrac_lifecycle_controller_job_status_info](modules/idrac_lifecycle_controller_job_status_info.rst) -- [idrac_lifecycle_controller_logs](modules/idrac_lifecycle_controller_logs.rst) -- [idrac_lifecycle_controller_status_info](modules/idrac_lifecycle_controller_status_info.rst) -- [idrac_network_attributes](modules/idrac_network_attributes.rst) -- [idrac_network](modules/idrac_network.rst) -- [idrac_os_deployment](modules/idrac_os_deployment.rst) -- [idrac_redfish_storage_controller](modules/idrac_redfish_storage_controller.rst) -- [idrac_reset](modules/idrac_reset.rst) -- [idrac_server_config_profile](modules/idrac_server_config_profile.rst) -- [idrac_syslog](modules/idrac_syslog.rst) -- [idrac_system_info](modules/idrac_system_info.rst) -- [idrac_timezone_ntp](modules/idrac_timezone_ntp.rst) -- [idrac_user](modules/idrac_user.rst) -- [idrac_user_info](modules/idrac_user_info.rst) -- [idrac_virtual_media](modules/idrac_virtual_media.rst) -- [redfish_event_subscription](modules/redfish_event_subscription.rst) -- [redfish_firmware](modules/redfish_firmware.rst) -- [redfish_powerstate](modules/redfish_powerstate.rst) -- [redfish_storage_volume](modules/redfish_storage_volume.rst) - +| Module Name | iDRAC8 | iDRAC9 | +| ---------------------------------------------------------------------------------------------------- | ------ | ------ | +| [dellemc_configure_idrac_eventing](modules/dellemc_configure_idrac_eventing.rst) | ✓ | ✓ | +| [dellemc_configure_idrac_services](modules/dellemc_configure_idrac_services.rst) | ✓ | ✓ | +| [dellemc_idrac_lc_attributes](modules/dellemc_idrac_lc_attributes.rst) | ✓ | ✓ | +| [dellemc_idrac_storage_volume](modules/dellemc_idrac_storage_volume.rst) | ✓ | ✓ | +| [dellemc_system_lockdown_mode](modules/dellemc_system_lockdown_mode.rst) | ✓ | ✓ | +| [idrac_attributes](modules/idrac_attributes.rst) | ✓ | ✓ | +| [idrac_bios](modules/idrac_bios.rst) | ✓ | ✓ | +| [idrac_boot](modules/idrac_boot.rst) | ✓ | ✓ | +| [idrac_certificates](modules/idrac_certificates.rst) | ✕ | ✓ | +| [idrac_diagnostics](modules/idrac_diagnostics.rst) | ✕ | ✓ | +| [idrac_firmware](modules/idrac_firmware.rst) | ✓ | ✓ | +| [idrac_firmware_info](modules/idrac_firmware_info.rst) | ✓ | ✓ | +| [idrac_lifecycle_controller_jobs](modules/idrac_lifecycle_controller_jobs.rst) | ✓ | ✓ | +| [idrac_lifecycle_controller_job_status_info](modules/idrac_lifecycle_controller_job_status_info.rst) | ✓ | ✓ | +| [idrac_lifecycle_controller_logs](modules/idrac_lifecycle_controller_logs.rst) | ✓ | ✓ | +| [idrac_lifecycle_controller_status_info](modules/idrac_lifecycle_controller_status_info.rst) | ✓ | ✓ | +| [idrac_network_attributes](modules/idrac_network_attributes.rst) | ✓ | ✓ | +| [idrac_network](modules/idrac_network.rst) | ✓ | ✓ | +| [idrac_os_deployment](modules/idrac_os_deployment.rst) | ✓ | ✓ | +| [idrac_redfish_storage_controller](modules/idrac_redfish_storage_controller.rst) | ✕ | ✓ | +| [idrac_reset](modules/idrac_reset.rst) | ✓ | ✓ | +| [idrac_server_config_profile](modules/idrac_server_config_profile.rst) | ✓ | ✓ | +| [idrac_session](modules/idrac_session.rst) | ✓ | ✓ | +| [idrac_storage_volume](modules/idrac_storage_volume.rst) | ✓ | ✓ | +| [idrac_syslog](modules/idrac_syslog.rst) | ✓ | ✓ | +| [idrac_system_info](modules/idrac_system_info.rst) | ✓ | ✓ | +| [idrac_timezone_ntp](modules/idrac_timezone_ntp.rst) | ✓ | ✓ | +| [idrac_user](modules/idrac_user.rst) | ✓ | ✓ | +| [idrac_user_info](modules/idrac_user_info.rst) | ✓ | ✓ | +| [idrac_virtual_media](modules/idrac_virtual_media.rst) | ✓ | ✓ | +| [redfish_event_subscription](modules/redfish_event_subscription.rst) | ✕ | ✓ | +| [redfish_firmware](modules/redfish_firmware.rst) | ✕ | ✓ | +| [redfish_firmware_rollback](modules/redfish_firmware_rollback.rst) | ✓ | ✓ | +| [redfish_powerstate](modules/redfish_powerstate.rst) | ✓ | ✓ | +| [redfish_storage_volume](modules/redfish_storage_volume.rst) | ✓ | ✓ | + ### OpenManage Enterprise Modules -- [ome_active_directory](modules/ome_active_directory.rst) -- [ome_alert_policies](modules/ome_alert_policies.rst) -- [ome_alert_policies_message_id_info](modules/ome_alert_policies_message_id_info.rst) -- [ome_alert_policies_info](modules/ome_alert_policies_info.rst) -- [ome_alert_policies_actions_info](modules/ome_alert_policies_actions_info.rst) -- [ome_alert_policies_category_info](modules/ome_alert_policies_category_info.rst) -- [ome_application_alerts_smtp](modules/ome_application_alerts_smtp.rst) -- [ome_application_alerts_syslog](modules/ome_application_alerts_syslog.rst) -- [ome_application_certificate](modules/ome_application_certificate.rst) -- [ome_application_console_preferences](modules/ome_application_console_preferences.rst) -- [ome_application_network_address](modules/ome_application_network_address.rst) -- [ome_application_network_proxy](modules/ome_application_network_proxy.rst) -- [ome_application_network_settings](modules/ome_application_network_settings.rst) -- [ome_application_network_time](modules/ome_application_network_time.rst) -- [ome_application_network_webserver](modules/ome_application_network_webserver.rst) -- [ome_application_security_settings](modules/ome_application_security_settings.rst) -- [ome_chassis_slots](modules/ome_chassis_slots.rst) -- [ome_configuration_compliance_baseline](modules/ome_configuration_compliance_baseline.rst) -- [ome_configuration_compliance_info](modules/ome_configuration_compliance_info.rst) -- [ome_device_group](modules/ome_device_group.rst) -- [ome_device_info](modules/ome_device_info.rst) -- [ome_device_local_access_configuration](modules/ome_device_local_access_configuration.rst) -- [ome_device_location](modules/ome_device_location.rst) -- [ome_device_mgmt_network](modules/ome_device_mgmt_network.rst) -- [ome_device_network_services](modules/ome_device_network_services.rst) -- [ome_device_power_settings](modules/ome_device_power_settings.rst) -- [ome_device_quick_deploy](modules/ome_device_quick_deploy.rst) -- [ome_devices](modules/ome_devices.rst) -- [ome_diagnostics](modules/ome_diagnostics.rst) -- [ome_discovery](modules/ome_discovery.rst) -- [ome_domain_user_groups](modules/ome_domain_user_groups.rst) -- [ome_firmware](modules/ome_firmware.rst) -- [ome_firmware_baseline](modules/ome_firmware_baseline.rst) -- [ome_firmware_baseline_compliance_info](modules/ome_firmware_baseline_compliance_info.rst) -- [ome_firmware_baseline_info](modules/ome_firmware_baseline_info.rst) -- [ome_firmware_catalog](modules/ome_firmware_catalog.rst) -- [ome_groups](modules/ome_groups.rst) -- [ome_identity_pool](modules/ome_identity_pool.rst) -- [ome_job_info](modules/ome_job_info.rst) -- [ome_network_port_breakout](modules/ome_network_port_breakout.rst) -- [ome_network_vlan](modules/ome_network_vlan.rst) -- [ome_network_vlan_info](modules/ome_network_vlan_info.rst) -- [ome_powerstate](modules/ome_powerstate.rst) -- [ome_profile](modules/ome_profile.rst) -- [ome_profile_info](modules/ome_profile_info.rst) -- [ome_server_interface_profile_info](modules/ome_server_interface_profile_info.rst) -- [ome_server_interface_profiles](modules/ome_server_interface_profiles.rst) -- [ome_smart_fabric_info](modules/ome_smart_fabric_info.rst) -- [ome_smart_fabric](modules/ome_smart_fabric.rst) -- [ome_smart_fabric_uplink_info](modules/ome_smart_fabric_uplink_info.rst) -- [ome_smart_fabric_uplink](modules/ome_smart_fabric_uplink.rst) -- [ome_template](modules/ome_template.rst) -- [ome_template_identity_pool](modules/ome_template_identity_pool.rst) -- [ome_template_info](modules/ome_template_info.rst) -- [ome_template_network_vlan](modules/ome_template_network_vlan.rst) -- [ome_template_network_vlan_info](modules/ome_template_network_vlan_info.rst) -- [ome_user](modules/ome_user.rst) -- [ome_user_info](modules/ome_user_info.rst) + +| Module Name | +| ------------------------------------------------------------------------------------------ | +| [ome_active_directory](modules/ome_active_directory.rst) | +| [ome_alert_policies](modules/ome_alert_policies.rst) | +| [ome_alert_policies_message_id_info](modules/ome_alert_policies_message_id_info.rst) | +| [ome_alert_policies_info](modules/ome_alert_policies_info.rst) | +| [ome_alert_policies_actions_info](modules/ome_alert_policies_actions_info.rst) | +| [ome_alert_policies_category_info](modules/ome_alert_policies_category_info.rst) | +| [ome_application_alerts_smtp](modules/ome_application_alerts_smtp.rst) | +| [ome_application_alerts_syslog](modules/ome_application_alerts_syslog.rst) | +| [ome_application_certificate](modules/ome_application_certificate.rst) | +| [ome_application_console_preferences](modules/ome_application_console_preferences.rst) | +| [ome_application_network_address](modules/ome_application_network_address.rst) | +| [ome_application_network_proxy](modules/ome_application_network_proxy.rst) | +| [ome_application_network_settings](modules/ome_application_network_settings.rst) | +| [ome_application_network_time](modules/ome_application_network_time.rst) | +| [ome_application_network_webserver](modules/ome_application_network_webserver.rst) | +| [ome_application_security_settings](modules/ome_application_security_settings.rst) | +| [ome_chassis_slots](modules/ome_chassis_slots.rst) | +| [ome_configuration_compliance_baseline](modules/ome_configuration_compliance_baseline.rst) | +| [ome_configuration_compliance_info](modules/ome_configuration_compliance_info.rst) | +| [ome_device_group](modules/ome_device_group.rst) | +| [ome_device_info](modules/ome_device_info.rst) | +| [ome_device_local_access_configuration](modules/ome_device_local_access_configuration.rst) | +| [ome_device_location](modules/ome_device_location.rst) | +| [ome_device_mgmt_network](modules/ome_device_mgmt_network.rst) | +| [ome_device_network_services](modules/ome_device_network_services.rst) | +| [ome_device_power_settings](modules/ome_device_power_settings.rst) | +| [ome_device_quick_deploy](modules/ome_device_quick_deploy.rst) | +| [ome_devices](modules/ome_devices.rst) | +| [ome_diagnostics](modules/ome_diagnostics.rst) | +| [ome_discovery](modules/ome_discovery.rst) | +| [ome_domain_user_groups](modules/ome_domain_user_groups.rst) | +| [ome_firmware](modules/ome_firmware.rst) | +| [ome_firmware_baseline](modules/ome_firmware_baseline.rst) | +| [ome_firmware_baseline_compliance_info](modules/ome_firmware_baseline_compliance_info.rst) | +| [ome_firmware_baseline_info](modules/ome_firmware_baseline_info.rst) | +| [ome_firmware_catalog](modules/ome_firmware_catalog.rst) | +| [ome_groups](modules/ome_groups.rst) | +| [ome_identity_pool](modules/ome_identity_pool.rst) | +| [ome_job_info](modules/ome_job_info.rst) | +| [ome_network_port_breakout](modules/ome_network_port_breakout.rst) | +| [ome_network_vlan](modules/ome_network_vlan.rst) | +| [ome_network_vlan_info](modules/ome_network_vlan_info.rst) | +| [ome_powerstate](modules/ome_powerstate.rst) | +| [ome_profile](modules/ome_profile.rst) | +| [ome_profile_info](modules/ome_profile_info.rst) | +| [ome_server_interface_profile_info](modules/ome_server_interface_profile_info.rst) | +| [ome_server_interface_profiles](modules/ome_server_interface_profiles.rst) | +| [ome_smart_fabric_info](modules/ome_smart_fabric_info.rst) | +| [ome_smart_fabric](modules/ome_smart_fabric.rst) | +| [ome_smart_fabric_uplink_info](modules/ome_smart_fabric_uplink_info.rst) | +| [ome_smart_fabric_uplink](modules/ome_smart_fabric_uplink.rst) | +| [ome_template](modules/ome_template.rst) | +| [ome_template_identity_pool](modules/ome_template_identity_pool.rst) | +| [ome_template_info](modules/ome_template_info.rst) | +| [ome_template_network_vlan](modules/ome_template_network_vlan.rst) | +| [ome_template_network_vlan_info](modules/ome_template_network_vlan_info.rst) | +| [ome_user](modules/ome_user.rst) | +| [ome_user_info](modules/ome_user_info.rst) |
\ No newline at end of file diff --git a/ansible_collections/dellemc/openmanage/docs/modules/idrac_diagnostics.rst b/ansible_collections/dellemc/openmanage/docs/modules/idrac_diagnostics.rst new file mode 100644 index 000000000..1a29769e0 --- /dev/null +++ b/ansible_collections/dellemc/openmanage/docs/modules/idrac_diagnostics.rst @@ -0,0 +1,390 @@ +.. _idrac_diagnostics_module: + + +idrac_diagnostics -- Run and Export iDRAC diagnostics +===================================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +This module allows you to run and export diagnostics on iDRAC. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python \>= 3.9.6 + + + +Parameters +---------- + + run (optional, bool, None) + Run the diagnostics job on iDRAC. + + Run the diagnostics job based on the \ :emphasis:`run\_mode`\ and save the report in the internal storage. \ :emphasis:`reboot\_type`\ is applicable. + + + export (optional, bool, None) + Exports the diagnostics information to the given share. + + This operation requires \ :emphasis:`share\_parameters`\ . + + When \ :emphasis:`run`\ is \ :literal:`true`\ and \ :emphasis:`job\_wait`\ is \ :literal:`false`\ , only then the run diagnostics job is triggered. \ :emphasis:`export`\ is ignored. + + + run_mode (optional, str, express) + This option provides the choices to run the diagnostics. + + \ :literal:`express`\ The express diagnostics runs a test package for each server subsystem. However, it does not run the complete set of tests available in the package for each subsystem. + + \ :literal:`extended`\ The extended diagnostics run all available tests in each test package for all subsystems. + + \ :literal:`long\_run`\ The long-run diagnostics runs express and extended tests. + + + reboot_type (optional, str, graceful) + This option provides the choice to reboot the host immediately to run the diagnostics. + + This is applicable when \ :emphasis:`run`\ is \ :literal:`true`\ . + + \ :literal:`force`\ Forced graceful shutdown signals the operating system to turn off and wait for ten minutes. If the operating system does not turn off, the iDRAC power cycles the system. + + \ :literal:`graceful`\ Graceful shutdown waits for the operating system to turn off and wait for the system to restart. + + \ :literal:`power\_cycle`\ performs a power cycle for a hard reset on the device. + + + scheduled_start_time (optional, str, None) + Schedules the job at the specified time. + + The accepted formats are yyyymmddhhmmss and YYYY-MM-DDThh:mm:ss+HH:MM. + + This is applicable when \ :emphasis:`run`\ is \ :literal:`true`\ and \ :emphasis:`reboot\_type`\ is power\_cycle. + + + scheduled_end_time (optional, str, None) + Run the diagnostic until the specified end date and end time after the \ :emphasis:`scheduled\_start\_time`\ . + + The accepted formats are yyyymmddhhmmss and YYYY-MM-DDThh:mm:ss+HH:MM. + + If the run operation does not complete before the specified end time, then the operation fails. + + This is applicable when \ :emphasis:`run`\ is \ :literal:`True`\ and \ :emphasis:`reboot\_type`\ is \ :literal:`power\_cycle`\ . + + + job_wait (optional, bool, True) + Provides the option to wait for job completion. + + This is applicable when \ :emphasis:`run`\ is \ :literal:`true`\ and \ :emphasis:`reboot\_type`\ is \ :literal:`power\_cycle`\ . + + This is applicable only to run the diagnostics job. + + + job_wait_timeout (optional, int, 1200) + Time in seconds to wait for job completion. + + This is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ . + + + share_parameters (optional, dict, None) + Parameters that are required for the export operation of diagnostics. + + \ :emphasis:`share\_parameters`\ is required when \ :emphasis:`export`\ is \ :literal:`true`\ . + + + share_type (optional, str, local) + Share type of the network share. + + \ :literal:`local`\ uses local path for \ :emphasis:`export`\ operation. + + \ :literal:`nfs`\ uses NFS share for \ :emphasis:`export`\ operation. + + \ :literal:`cifs`\ uses CIFS share for \ :emphasis:`export`\ operation. + + \ :literal:`http`\ uses HTTP share for \ :emphasis:`export`\ operation. + + \ :literal:`https`\ uses HTTPS share for \ :emphasis:`export`\ operation. + + + file_name (optional, str, None) + Diagnostics file name for \ :emphasis:`export`\ operation. + + + ip_address (optional, str, None) + IP address of the network share. + + \ :emphasis:`ip\_address`\ is required when \ :emphasis:`share\_type`\ is \ :literal:`nfs`\ , \ :literal:`cifs`\ , \ :literal:`http`\ or \ :literal:`https`\ . + + + share_name (optional, str, None) + Network share or local path of the diagnostics file. + + + workgroup (optional, str, None) + Workgroup of the network share. + + \ :emphasis:`workgroup`\ is applicable only when \ :emphasis:`share\_type`\ is \ :literal:`cifs`\ . + + + username (optional, str, None) + Username of the network share. + + \ :emphasis:`username`\ is required when \ :emphasis:`share\_type`\ is \ :literal:`cifs`\ . + + + password (optional, str, None) + Password of the network share. + + \ :emphasis:`password`\ is required when \ :emphasis:`share\_type`\ is \ :literal:`cifs`\ . + + + ignore_certificate_warning (optional, str, off) + Ignores the certificate warning while connecting to Share and is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`https`\ . + + \ :literal:`off`\ ignores the certificate warning. + + \ :literal:`on`\ does not ignore the certificate warning. + + + proxy_support (optional, str, off) + Specifies if proxy support must be used or not. + + \ :literal:`off`\ does not use proxy settings. + + \ :literal:`default\_proxy`\ uses the default proxy settings. + + \ :literal:`parameters\_proxy`\ uses the specified proxy settings. \ :emphasis:`proxy\_server`\ is required when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + \ :emphasis:`proxy\_support`\ is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`http`\ or \ :literal:`https`\ . + + + proxy_type (optional, str, http) + The proxy type of the proxy server. + + \ :literal:`http`\ to select HTTP proxy. + + \ :literal:`socks`\ to select SOCKS proxy. + + \ :emphasis:`proxy\_type`\ is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`http`\ or \ :literal:`https`\ and when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + + proxy_server (optional, str, None) + The IP address of the proxy server. + + \ :emphasis:`proxy\_server`\ is required when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + \ :emphasis:`proxy\_server`\ is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`http`\ or \ :literal:`https`\ and when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + + proxy_port (optional, int, 80) + The port of the proxy server. + + \ :emphasis:`proxy\_port`\ is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`http`\ or \ :literal:`https`\ and when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + + proxy_username (optional, str, None) + The username of the proxy server. + + \ :emphasis:`proxy\_username`\ is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`http`\ or \ :literal:`https`\ and when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + + proxy_password (optional, str, None) + The password of the proxy server. + + \ :emphasis:`proxy\_password`\ is only applicable when \ :emphasis:`share\_type`\ is \ :literal:`http`\ or \ :literal:`https`\ and when \ :emphasis:`proxy\_support`\ is \ :literal:`parameters\_proxy`\ . + + + + resource_id (optional, str, None) + Id of the resource. + + If the value for resource ID is not provided, the module picks the first resource ID available from the list of system resources returned by the iDRAC. + + + idrac_ip (True, str, None) + iDRAC IP Address. + + + idrac_user (True, str, None) + iDRAC username. + + + idrac_password (True, str, None) + iDRAC user password. + + + idrac_port (optional, int, 443) + iDRAC port. + + + validate_certs (optional, bool, True) + If \ :literal:`false`\ , the SSL certificates will not be validated. + + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. + + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. + + + ca_path (optional, path, None) + The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. + + + timeout (optional, int, 30) + The socket level timeout in seconds. + + + + + +Notes +----- + +.. note:: + - Run this module from a system that has direct access to Dell iDRAC. + - This module supports only iDRAC9 and above. + - This module supports IPv4 and IPv6 addresses. + - This module supports \ :literal:`check\_mode`\ . + - This module requires 'Dell Diagnostics' firmware package to be present on the server. + - When \ :emphasis:`share\_type`\ is \ :literal:`local`\ for \ :emphasis:`export`\ operation, job\_details are not displayed. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + --- + - name: Run and export the diagnostics to local path + dellemc.openmanage.idrac_diagnostics: + hostname: "192.168.0.1" + username: "username" + password: "password" + ca_path: "path/to/ca_file" + run: true + export: true + share_parameters: + share_type: "local" + share_path: "/opt/local/diagnostics/" + file_name: "diagnostics.txt" + + - name: Run the diagnostics with power cycle reboot on schedule + dellemc.openmanage.idrac_diagnostics: + hostname: "192.168.0.1" + username: "username" + password: "password" + ca_path: "path/to/ca_file" + run: true + run_mode: "express" + reboot_type: "power_cycle" + scheduled_start_time: 20240101101015 + + - name: Run and export the diagnostics to HTTPS share + dellemc.openmanage.idrac_diagnostics: + hostname: "192.168.0.1" + username: "username" + password: "password" + ca_path: "path/to/ca_file" + run: true + export: true + share_parameters: + share_type: "HTTPS" + ignore_certificate_warning: "on" + share_name: "/share_path/diagnostics_collection_path" + ip_address: "192.168.0.2" + file_name: "diagnostics.txt" + + - name: Run and export the diagnostics to NFS share + dellemc.openmanage.idrac_diagnostics: + hostname: "192.168.0.1" + username: "username" + password: "password" + ca_path: "path/to/ca_file" + run: true + export: true + share_parameters: + share_type: "NFS" + share_name: "nfsshare/diagnostics_collection_path/" + ip_address: "192.168.0.3" + file_name: "diagnostics.txt" + + - name: Export the diagnostics to CIFS share + dellemc.openmanage.idrac_diagnostics: + hostname: "192.168.0.1" + username: "username" + password: "password" + ca_path: "path/to/ca_file" + export: true + share_parameters: + share_type: "CIFS" + share_name: "/cifsshare/diagnostics_collection_path/" + ip_address: "192.168.0.4" + file_name: "diagnostics.txt" + + - name: Export the diagnostics to HTTPS share via proxy + dellemc.openmanage.idrac_diagnostics: + hostname: "192.168.0.1" + username: "username" + password: "password" + ca_path: "path/to/ca_file" + export: true + share_parameters: + share_type: "HTTPS" + share_name: "/share_path/diagnostics_collection_path" + ignore_certificate_warning: "on" + ip_address: "192.168.0.2" + file_name: "diagnostics.txt" + proxy_support: parameters_proxy + proxy_type: http + proxy_server: "192.168.0.5" + proxy_port: 1080 + proxy_username: "proxy_user" + proxy_password: "proxy_password" + + + +Return Values +------------- + +msg (always, str, Successfully ran and exported the diagnostics.) + Status of the diagnostics operation. + + +job_details (For run and export operations, dict, {'ActualRunningStartTime': '2024-01-10T10:14:31', 'ActualRunningStopTime': '2024-01-10T10:26:34', 'CompletionTime': '2024-01-10T10:26:34', 'Description': 'Job Instance', 'EndTime': '2024-01-10T10:30:15', 'Id': 'JID_XXXXXXXXXXXX', 'JobState': 'Completed', 'JobType': 'RemoteDiagnostics', 'Message': 'Job completed successfully.', 'MessageArgs': [], 'MessageArgs@odata.count': 0, 'MessageId': 'SYS018', 'Name': 'Remote Diagnostics', 'PercentComplete': 100, 'StartTime': '2024-01-10T10:12:15', 'TargetSettingsURI': None}) + Returns the output for status of the job. + + +diagnostics_file_path (For export operation, str, /share_path/diagnostics_collection_path/diagnostics.txt) + Returns the full path of the diagnostics file. + + +error_info (on HTTP error, dict, {'error': {'code': 'Base.1.12.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.', '@Message.ExtendedInfo': [{'Message': 'A Remote Diagnostic (ePSA) job already exists.', 'MessageArgs': [], 'MessageArgs@odata.count': 0, 'MessageId': 'IDRAC.2.9.SYS098', 'RelatedProperties': [], 'RelatedProperties@odata.count': 0, 'Resolution': 'A response action is not required if the scheduled start time of the existing Remote Diagnostic (ePSA) job is ok. Else, delete the existing Diagnostics (ePSA) job and recreate another with an appropriate start time.', 'Severity': 'Informational'}]}}) + Details of the HTTP Error. + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Shivam Sharma(@ShivamSh3) + diff --git a/ansible_collections/dellemc/openmanage/docs/modules/idrac_reset.rst b/ansible_collections/dellemc/openmanage/docs/modules/idrac_reset.rst index e0efdc9f9..85ec3ca3c 100644 --- a/ansible_collections/dellemc/openmanage/docs/modules/idrac_reset.rst +++ b/ansible_collections/dellemc/openmanage/docs/modules/idrac_reset.rst @@ -1,8 +1,8 @@ .. _idrac_reset_module: -idrac_reset -- Reset iDRAC -========================== +idrac_reset -- Factory reset the iDRACs +======================================= .. contents:: :local: @@ -12,9 +12,7 @@ idrac_reset -- Reset iDRAC Synopsis -------- -This module resets iDRAC. - -iDRAC is not accessible for some time after running this module. It is recommended to wait for some time, before trying to connect to iDRAC. +This module resets the iDRAC to factory default settings. @@ -22,14 +20,57 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- omsdk >= 1.2.488 -- python >= 3.9.6 +- python \>= 3.9.6 Parameters ---------- + reset_to_default (optional, str, None) + If this value is not set the default behaviour is to restart the iDRAC. + + \ :literal:`All`\ Discards all settings and reset to default credentials. + + \ :literal:`ResetAllWithRootDefaults`\ Discards all settings and reset the default username to root and password to the shipping value. + + \ :literal:`Default`\ Discards all settings, but preserves user and network settings. + + \ :literal:`CustomDefaults`\ All configuration is set to custom defaults.This option is supported on firmware version 7.00.00.00 and newer versions. + + + custom_defaults_file (optional, str, None) + Name of the custom default configuration file in the XML format. + + This option is applicable when \ :emphasis:`reset\_to\_default`\ is \ :literal:`CustomDefaults`\ . + + \ :emphasis:`custom\_defaults\_file`\ is mutually exclusive with \ :emphasis:`custom\_defaults\_buffer`\ . + + + custom_defaults_buffer (optional, str, None) + This parameter provides the option to import the buffer input in XML format as a custom default configuration. + + This option is applicable when \ :emphasis:`reset\_to\_default`\ is \ :literal:`CustomDefaults`\ . + + \ :emphasis:`custom\_defaults\_buffer`\ is mutually exclusive with \ :emphasis:`custom\_defaults\_file`\ . + + + wait_for_idrac (optional, bool, True) + This parameter provides the option to wait for the iDRAC to reset and lifecycle controller status to be ready. + + + job_wait_timeout (optional, int, 600) + Time in seconds to wait for job completion. + + This is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ . + + + force_reset (optional, bool, False) + This parameter provides the option to force reset the iDRAC without checking the iDRAC lifecycle controller status. + + This option is applicable only for iDRAC9. + + idrac_ip (True, str, None) iDRAC IP Address. @@ -37,21 +78,29 @@ Parameters idrac_user (True, str, None) iDRAC username. + If the username is not provided, then the environment variable \ :literal:`IDRAC\_USERNAME`\ is used. + + Example: export IDRAC\_USERNAME=username + idrac_password (True, str, None) iDRAC user password. + If the password is not provided, then the environment variable \ :literal:`IDRAC\_PASSWORD`\ is used. + + Example: export IDRAC\_PASSWORD=password + idrac_port (optional, int, 443) iDRAC port. validate_certs (optional, bool, True) - If ``false``, the SSL certificates will not be validated. + If \ :literal:`false`\ , the SSL certificates will not be validated. - Configure ``false`` only on personally controlled sites where self-signed certificates are used. + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. - Prior to collection version ``5.0.0``, the *validate_certs* is ``false`` by default. + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. ca_path (optional, path, None) @@ -70,8 +119,10 @@ Notes .. note:: - Run this module from a system that has direct access to Dell iDRAC. - - This module supports both IPv4 and IPv6 address for *idrac_ip*. - - This module supports ``check_mode``. + - This module supports both IPv4 and IPv6 address for \ :emphasis:`idrac\_ip`\ . + - This module supports \ :literal:`check\_mode`\ . + - If reset\_to\_default option is not specified, then this module triggers a graceful restart. + - This module skips the execution if reset options are not supported by the iDRAC. @@ -83,13 +134,57 @@ Examples --- - - name: Reset iDRAC + - name: Reset the iDRAC to all and wait till the iDRAC is accessible. + dellemc.openmanage.idrac_reset: + idrac_ip: "192.168.0.1" + idrac_user: "user_name" + idrac_password: "user_password" + ca_path: "/path/to/ca_cert.pem" + reset_to_default: "All" + + - name: Reset the iDRAC to default and do not wait till the iDRAC is accessible. + dellemc.openmanage.idrac_reset: + idrac_ip: "192.168.0.1" + idrac_user: "user_name" + idrac_password: "user_password" + ca_path: "/path/to/ca_cert.pem" + reset_to_default: "Default" + wait_for_idrac: false + + - name: Force reset the iDRAC to default. + dellemc.openmanage.idrac_reset: + idrac_ip: "192.168.0.1" + idrac_user: "user_name" + idrac_password: "user_password" + ca_path: "/path/to/ca_cert.pem" + reset_to_default: "Default" + force_reset: true + + - name: Gracefully restart the iDRAC. + dellemc.openmanage.idrac_reset: + idrac_ip: "192.168.0.1" + idrac_user: "user_name" + idrac_password: "user_password" + ca_path: "/path/to/ca_cert.pem" + + - name: Reset the iDRAC to custom defaults XML and do not wait till the iDRAC is accessible. + dellemc.openmanage.idrac_reset: + idrac_ip: "192.168.0.1" + idrac_user: "user_name" + idrac_password: "user_password" + ca_path: "/path/to/ca_cert.pem" + reset_to_default: "CustomDefaults" + custom_defaults_file: "/path/to/custom_defaults.xml" + + - name: Reset the iDRAC to custom defaults buffer input and do not wait till the iDRAC is accessible. dellemc.openmanage.idrac_reset: - idrac_ip: "192.168.0.1" - idrac_user: "user_name" - idrac_password: "user_password" - idrac_port: 443 - ca_path: "/path/to/ca_cert.pem" + idrac_ip: "192.168.0.1" + idrac_user: "user_name" + idrac_password: "user_password" + ca_path: "/path/to/ca_cert.pem" + reset_to_default: "CustomDefaults" + custom_defaults_buffer: "<SystemConfiguration Model=\"PowerEdge R7525\" ServiceTag=\"ABCD123\">\n<Component FQDD=\"iDRAC.Embedded.1\">\n + <Attribute Name=\"IPMILan.1#Enable\">Disabled</Attribute>\n </Component>\n\n</SystemConfiguration>" @@ -100,7 +195,7 @@ msg (always, str, Successfully performed iDRAC reset.) Status of the iDRAC reset operation. -reset_status (always, dict, {'idracreset': {'Data': {'StatusCode': 204}, 'Message': 'none', 'Status': 'Success', 'StatusCode': 204, 'retval': True}}) +reset_status (reset operation is triggered., dict, {'idracreset': {'Data': {'StatusCode': 204}, 'Message': 'none', 'Status': 'Success', 'StatusCode': 204, 'retval': True}}) Details of iDRAC reset operation. @@ -123,4 +218,5 @@ Authors - Felix Stephen (@felixs88) - Anooja Vardhineni (@anooja-vardhineni) +- Lovepreet Singh (@singh-lovepreet1) diff --git a/ansible_collections/dellemc/openmanage/docs/modules/idrac_session.rst b/ansible_collections/dellemc/openmanage/docs/modules/idrac_session.rst new file mode 100644 index 000000000..d8f980043 --- /dev/null +++ b/ansible_collections/dellemc/openmanage/docs/modules/idrac_session.rst @@ -0,0 +1,157 @@ +.. _idrac_session_module: + + +idrac_session -- Manage iDRAC sessions +====================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +This module allows the creation and deletion of sessions on iDRAC. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python \>= 3.9.6 + + + +Parameters +---------- + + hostname (optional, str, None) + IP address or hostname of the iDRAC. + + + username (optional, str, None) + Username of the iDRAC. + + \ :emphasis:`username`\ is required when \ :emphasis:`state`\ is \ :literal:`present`\ . + + + password (optional, str, None) + Password of the iDRAC. + + \ :emphasis:`password`\ is required when \ :emphasis:`state`\ is \ :literal:`present`\ . + + + port (optional, int, 443) + Port of the iDRAC. + + + validate_certs (optional, bool, True) + If \ :literal:`false`\ , the SSL certificates will not be validated. + + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. + + + ca_path (optional, path, None) + The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. + + + timeout (optional, int, 30) + The https socket level timeout in seconds. + + + state (optional, str, present) + The state of the session in an iDRAC. + + \ :literal:`present`\ creates a session. + + \ :literal:`absent`\ deletes a session. + + Module will always report changes found to be applied when \ :emphasis:`state`\ is \ :literal:`present`\ . + + + auth_token (optional, str, None) + Authentication token. + + \ :emphasis:`auth\_token`\ is required when \ :emphasis:`state`\ is \ :literal:`absent`\ . + + + session_id (optional, int, None) + Session ID of the iDRAC. + + \ :emphasis:`session\_id`\ is required when \ :emphasis:`state`\ is \ :literal:`absent`\ . + + + + + +Notes +----- + +.. note:: + - Run this module from a system that has direct access to Dell iDRAC. + - This module supports IPv4 and IPv6 addresses. + - This module supports \ :literal:`check\_mode`\ . + - This module will always report changes found to be applied when \ :emphasis:`state`\ is \ :literal:`present`\ . + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + --- + - name: Create a session + dellemc.openmanage.idrac_session: + hostname: 198.162.0.1 + username: username + password: password + state: present + + - name: Delete a session + dellemc.openmanage.idrac_session: + hostname: 198.162.0.1 + state: absent + auth_token: aed4aa802b748d2f3b31deec00a6b28a + session_is: 2 + + + +Return Values +------------- + +msg (always, str, The session has been created successfully.) + Status of the session operation. + + +session_data (For session creation operation, dict, {'@Message.ExtendedInfo': [{'Message': 'The resource has been created successfully.', 'MessageArgs': [], 'MessageId': 'Base.1.12.Created', 'RelatedProperties': [], 'Resolution': 'None.', 'Severity': 'OK'}, {'Message': 'A new resource is successfully created.', 'MessageArgs': [], 'MessageId': 'IDRAC.2.9.SYS414', 'RelatedProperties': [], 'Resolution': 'No response action is required.', 'Severity': 'Informational'}], 'ClientOriginIPAddress': '100.96.37.58', 'CreatedTime': '2024-04-05T01:14:01-05:00', 'Description': 'User Session', 'Id': '74', 'Name': 'User Session', 'Password': None, 'SessionType': 'Redfish', 'UserName': 'root'}) + The session details. + + +x_auth_token (For session creation operation, str, d15f17f01cd627c30173b1582642497d) + Authentication token. + + +error_info (On HTTP error, dict, {'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to complete the operation because an invalid username and/or password is entered, and therefore authentication failed.', 'MessageArgs': [], 'MessageId': 'IDRAC.2.9.SYS415', 'RelatedProperties': [], 'Resolution': 'Enter valid user name and password and retry the operation.', 'Severity': 'Warning'}], 'code': 'Base.1.12.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information'}}) + Details of the HTTP Error. + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Rajshekar P(@rajshekarp87) + diff --git a/ansible_collections/dellemc/openmanage/docs/modules/idrac_storage_volume.rst b/ansible_collections/dellemc/openmanage/docs/modules/idrac_storage_volume.rst new file mode 100644 index 000000000..5cfefc036 --- /dev/null +++ b/ansible_collections/dellemc/openmanage/docs/modules/idrac_storage_volume.rst @@ -0,0 +1,310 @@ +.. _idrac_storage_volume_module: + + +idrac_storage_volume -- Configures the RAID configuration attributes +==================================================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +This module is responsible for configuring the RAID attributes. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python \>= 3.9.6 + + + +Parameters +---------- + + state (optional, str, view) + \ :literal:`create`\ , performs create volume operation. + + \ :literal:`delete`\ , performs remove volume operation. + + \ :literal:`view`\ , returns storage view. + + + span_depth (optional, int, 1) + Number of spans in the RAID configuration. + + \ :emphasis:`span\_depth`\ is required for \ :literal:`create`\ and its value depends on \ :emphasis:`volume\_type`\ . + + + span_length (optional, int, 1) + Number of disks in a span. + + \ :emphasis:`span\_length`\ is required for \ :literal:`create`\ and its value depends on \ :emphasis:`volume\_type`\ . + + + number_dedicated_hot_spare (optional, int, 0) + Number of Dedicated Hot Spare. + + + volume_type (optional, str, RAID 0) + Provide the the required RAID level. + + + disk_cache_policy (optional, str, Default) + Disk Cache Policy. + + + write_cache_policy (optional, str, WriteThrough) + Write cache policy. + + + read_cache_policy (optional, str, NoReadAhead) + Read cache policy. + + + stripe_size (optional, int, 65536) + Stripe size value to be provided in multiples of 64 \* 1024. + + + controller_id (optional, str, None) + Fully Qualified Device Descriptor (FQDD) of the storage controller, for example 'RAID.Integrated.1-1'. Controller FQDD is required for \ :literal:`create`\ RAID configuration. + + + media_type (optional, str, None) + Media type. + + + protocol (optional, str, None) + Bus protocol. + + + volume_id (optional, str, None) + Fully Qualified Device Descriptor (FQDD) of the virtual disk, for example 'Disk.virtual.0:RAID.Slot.1-1'. This option is used to get the virtual disk information. + + + volumes (optional, list, None) + A list of virtual disk specific iDRAC attributes. This is applicable for \ :literal:`create`\ and \ :literal:`delete`\ operations. + + For \ :literal:`create`\ operation, name and drives are applicable options, other volume options can also be specified. + + The drives is a required option for \ :literal:`create`\ operation and accepts either location (list of drive slot) or id (list of drive fqdd). + + In iDRAC8, there is no pre-validation for the state of drives. The disk ID or slot number of the drive provided may or may not be in Ready state. Enter the disk ID or slot number of the drive that is already in Ready state. + + For \ :literal:`delete`\ operation, only name option is applicable. + + See the examples for more details. + + + capacity (optional, float, None) + Virtual disk size in GB. + + + raid_reset_config (optional, str, false) + This option represents whether a reset config operation needs to be performed on the RAID controller. Reset Config operation deletes all the virtual disks present on the RAID controller. + + + raid_init_operation (optional, str, None) + This option represents initialization configuration operation to be performed on the virtual disk. + + + job_wait (optional, bool, True) + This parameter provides the option to wait for the job completion. + + This is applicable when \ :emphasis:`state`\ is \ :literal:`create`\ or \ :literal:`delete`\ . + + + job_wait_timeout (optional, int, 900) + This parameter is the maximum wait time of \ :emphasis:`job\_wait`\ in seconds. + + This option is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ . + + + idrac_ip (True, str, None) + iDRAC IP Address. + + + idrac_user (True, str, None) + iDRAC username. + + If the username is not provided, then the environment variable \ :literal:`IDRAC\_USERNAME`\ is used. + + Example: export IDRAC\_USERNAME=username + + + idrac_password (True, str, None) + iDRAC user password. + + If the password is not provided, then the environment variable \ :literal:`IDRAC\_PASSWORD`\ is used. + + Example: export IDRAC\_PASSWORD=password + + + idrac_port (optional, int, 443) + iDRAC port. + + + validate_certs (optional, bool, True) + If \ :literal:`false`\ , the SSL certificates will not be validated. + + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. + + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. + + + ca_path (optional, path, None) + The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. + + + timeout (optional, int, 30) + The socket level timeout in seconds. + + + + + +Notes +----- + +.. note:: + - Run this module from a system that has direct access to Integrated Dell Remote Access Controller. + - This module supports both IPv4 and IPv6 address for \ :emphasis:`idrac\_ip`\ . + - This module supports \ :literal:`check\_mode`\ . + - This module does not display the controller battery details for the \ :literal:`view`\ operation of the storage in iDRAC8. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + --- + - name: Create single volume + dellemc.openmanage.idrac_storage_volume: + idrac_ip: "192.168.0.1" + idrac_user: "username" + idrac_password: "password" + ca_path: "/path/to/ca_cert.pem" + state: "create" + controller_id: "RAID.Slot.1-1" + volumes: + - drives: + location: [5] + + - name: Create multiple volume + dellemc.openmanage.idrac_storage_volume: + idrac_ip: "192.168.0.1" + idrac_user: "username" + idrac_password: "password" + ca_path: "/path/to/ca_cert.pem" + raid_reset_config: "True" + state: "create" + controller_id: "RAID.Slot.1-1" + volume_type: "RAID 1" + span_depth: 1 + span_length: 2 + number_dedicated_hot_spare: 1 + disk_cache_policy: "Enabled" + write_cache_policy: "WriteBackForce" + read_cache_policy: "ReadAhead" + stripe_size: 65536 + capacity: 100 + raid_init_operation: "Fast" + volumes: + - name: "volume_1" + drives: + id: ["Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1", "Disk.Bay.2:Enclosure.Internal.0-1:RAID.Slot.1-1"] + - name: "volume_2" + volume_type: "RAID 5" + span_length: 3 + span_depth: 1 + drives: + location: [7, 3, 5] + disk_cache_policy: "Disabled" + write_cache_policy: "WriteBack" + read_cache_policy: "NoReadAhead" + stripe_size: 131072 + capacity: "200" + raid_init_operation: "None" + + - name: View all volume details + dellemc.openmanage.idrac_storage_volume: + idrac_ip: "192.168.0.1" + idrac_user: "username" + idrac_password: "password" + ca_path: "/path/to/ca_cert.pem" + state: "view" + + - name: View specific volume details + dellemc.openmanage.idrac_storage_volume: + idrac_ip: "192.168.0.1" + idrac_user: "username" + idrac_password: "password" + ca_path: "/path/to/ca_cert.pem" + state: "view" + controller_id: "RAID.Slot.1-1" + volume_id: "Disk.Virtual.0:RAID.Slot.1-1" + + - name: Delete single volume + dellemc.openmanage.idrac_storage_volume: + idrac_ip: "192.168.0.1" + idrac_user: "username" + idrac_password: "password" + ca_path: "/path/to/ca_cert.pem" + state: "delete" + volumes: + - name: "volume_1" + + - name: Delete multiple volume + dellemc.openmanage.idrac_storage_volume: + idrac_ip: "192.168.0.1" + idrac_user: "username" + idrac_password: "password" + ca_path: "/path/to/ca_cert.pem" + state: "delete" + volumes: + - name: "volume_1" + - name: "volume_2" + + + +Return Values +------------- + +msg (always, str, Successfully completed the view storage volume operation) + Overall status of the storage configuration operation. + + +storage_status (success, dict, {'Id': 'JID_XXXXXXXXX', 'JobState': 'Completed', 'JobType': 'ImportConfiguration', 'Message': 'Successfully imported and applied Server Configuration Profile.', 'MessageId': 'XXX123', 'Name': 'Import Configuration', 'PercentComplete': 100, 'StartTime': 'TIME_NOW', 'TargetSettingsURI': None}) + Storage configuration job and progress details from the iDRAC. + + +error_info (on HTTP error, dict, {'error': {'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.', '@Message.ExtendedInfo': [{'MessageId': 'GEN1234', 'RelatedProperties': [], 'Message': 'Unable to process the request because an error occurred.', 'MessageArgs': [], 'Severity': 'Critical', 'Resolution': 'Retry the operation. If the issue persists, contact your system administrator.'}]}}) + Details of the HTTP Error. + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Felix Stephen (@felixs88) +- Kritika Bhateja (@Kritika-Bhateja-03) +- Abhishek Sinha(@ABHISHEK-SINHA10) + diff --git a/ansible_collections/dellemc/openmanage/docs/modules/ome_application_console_preferences.rst b/ansible_collections/dellemc/openmanage/docs/modules/ome_application_console_preferences.rst index 79ce3f7d4..45292acd0 100644 --- a/ansible_collections/dellemc/openmanage/docs/modules/ome_application_console_preferences.rst +++ b/ansible_collections/dellemc/openmanage/docs/modules/ome_application_console_preferences.rst @@ -20,7 +20,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.8.6 +- python \>= 3.9.6 @@ -42,17 +42,17 @@ Parameters health_check_interval_unit (optional, str, None) The time unit of the frequency at which the device health must be recorded and data stored. - ``Hourly`` to set the frequency in hours. + \ :literal:`Hourly`\ to set the frequency in hours. - ``Minutes`` to set the frequency in minutes. + \ :literal:`Minutes`\ to set the frequency in minutes. health_and_power_state_on_connection_lost (optional, str, None) The latest recorded device health. - ``last_known`` to display the latest recorded device health when the power connection was lost. + \ :literal:`last\_known`\ to display the latest recorded device health when the power connection was lost. - ``unknown`` to display the latest recorded device health when the device status moved to unknown. + \ :literal:`unknown`\ to display the latest recorded device health when the device status moved to unknown. @@ -63,17 +63,17 @@ Parameters general_device_naming (optional, str, DNS) Applicable to all the discovered devices other than the iDRACs. - ``DNS`` to use the DNS name. + \ :literal:`DNS`\ to use the DNS name. - ``NETBIOS`` to use the NetBIOS name. + \ :literal:`NETBIOS`\ to use the NetBIOS name. server_device_naming (optional, str, IDRAC_SYSTEM_HOSTNAME) Applicable to iDRACs only. - ``IDRAC_HOSTNAME`` to use the iDRAC hostname. + \ :literal:`IDRAC\_HOSTNAME`\ to use the iDRAC hostname. - ``IDRAC_SYSTEM_HOSTNAME`` to use the system hostname. + \ :literal:`IDRAC\_SYSTEM\_HOSTNAME`\ to use the system hostname. invalid_device_hostname (optional, str, None) @@ -92,9 +92,9 @@ Parameters device_discovery_approval_policy (optional, str, None) Discovery approval policies. - ``Automatic`` allows servers with iDRAC Firmware version 4.00.00.00, which are on the same network as the console, to be discovered automatically by the console. + \ :literal:`Automatic`\ allows servers with iDRAC Firmware version 4.00.00.00, which are on the same network as the console, to be discovered automatically by the console. - ``Manual`` for the servers to be discovered by the user manually. + \ :literal:`Manual`\ for the servers to be discovered by the user manually. set_trap_destination (optional, bool, None) @@ -105,9 +105,9 @@ Parameters mx7000_onboarding_preferences (optional, str, None) Alert-forwarding behavior on chassis when they are onboarded. - ``all`` to receive all alert. + \ :literal:`all`\ to receive all alert. - ``chassis`` to receive chassis category alerts only. + \ :literal:`chassis`\ to receive chassis category alerts only. builtin_appliance_share (optional, dict, None) @@ -117,19 +117,19 @@ Parameters share_options (optional, str, None) The share options. - ``CIFS`` to select CIFS share type. + \ :literal:`CIFS`\ to select CIFS share type. - ``HTTPS`` to select HTTPS share type. + \ :literal:`HTTPS`\ to select HTTPS share type. cifs_options (optional, str, None) The SMB protocol version. - *cifs_options* is required *share_options* is ``CIFS``. + \ :emphasis:`cifs\_options`\ is required \ :emphasis:`share\_options`\ is \ :literal:`CIFS`\ . - ``V1`` to enable SMBv1. + \ :literal:`V1`\ to enable SMBv1. - ``V2`` to enable SMBv2 + \ :literal:`V2`\ to enable SMBv2 @@ -140,9 +140,9 @@ Parameters trap_forwarding_format (optional, str, None) The trap forwarding format. - ``Original`` to retain the trap data as is. + \ :literal:`Original`\ to retain the trap data as is. - ``Normalized`` to normalize the trap data. + \ :literal:`Normalized`\ to normalize the trap data. metrics_collection_settings (optional, int, None) @@ -166,11 +166,11 @@ Parameters validate_certs (optional, bool, True) - If ``false``, the SSL certificates will not be validated. + If \ :literal:`false`\ , the SSL certificates will not be validated. - Configure ``false`` only on personally controlled sites where self-signed certificates are used. + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. - Prior to collection version ``5.0.0``, the *validate_certs* is ``false`` by default. + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. ca_path (optional, path, None) @@ -188,7 +188,7 @@ Notes ----- .. note:: - - This module supports ``check_mode``. + - This module supports \ :literal:`check\_mode`\ . @@ -311,4 +311,5 @@ Authors - Sachin Apagundi(@sachin-apa) - Husniya Hameed (@husniya-hameed) +- ShivamSh3 (@ShivamSh3) diff --git a/ansible_collections/dellemc/openmanage/docs/modules/ome_device_local_access_configuration.rst b/ansible_collections/dellemc/openmanage/docs/modules/ome_device_local_access_configuration.rst index a5846243e..1deafefb0 100644 --- a/ansible_collections/dellemc/openmanage/docs/modules/ome_device_local_access_configuration.rst +++ b/ansible_collections/dellemc/openmanage/docs/modules/ome_device_local_access_configuration.rst @@ -20,7 +20,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.8.6 +- python \>= 3.9.6 @@ -30,17 +30,17 @@ Parameters device_id (optional, int, None) The ID of the chassis for which the local access configuration to be updated. - If the device ID is not specified, this module updates the local access settings for the *hostname*. + If the device ID is not specified, this module updates the local access settings for the \ :emphasis:`hostname`\ . - *device_id* is mutually exclusive with *device_service_tag*. + \ :emphasis:`device\_id`\ is mutually exclusive with \ :emphasis:`device\_service\_tag`\ . device_service_tag (optional, str, None) The service tag of the chassis for which the local access settings needs to be updated. - If the device service tag is not specified, this module updates the local access settings for the *hostname*. + If the device service tag is not specified, this module updates the local access settings for the \ :emphasis:`hostname`\ . - *device_service_tag* is mutually exclusive with *device_id*. + \ :emphasis:`device\_service\_tag`\ is mutually exclusive with \ :emphasis:`device\_id`\ . enable_kvm_access (optional, bool, None) @@ -58,21 +58,21 @@ Parameters enable_chassis_power_button (True, bool, None) Enables or disables the chassis power button. - If ``false``, the chassis cannot be turn on or turn off using the power button. + If \ :literal:`false`\ , the chassis cannot be turn on or turn off using the power button. enable_lcd_override_pin (optional, bool, None) Enables or disables the LCD override pin. - This is required when *enable_chassis_power_button* is ``false``. + This is required when \ :emphasis:`enable\_chassis\_power\_button`\ is \ :literal:`false`\ . disabled_button_lcd_override_pin (optional, str, None) The six digit LCD override pin to change the power state of the chassis. - This is required when *enable_lcd_override_pin* is ``true``. + This is required when \ :emphasis:`enable\_lcd\_override\_pin`\ is \ :literal:`true`\ . - The module will always report change when *disabled_button_lcd_override_pin* is ``true``. + The module will always report change when \ :emphasis:`disabled\_button\_lcd\_override\_pin`\ is \ :literal:`true`\ . The value must be specified in quotes. ex: "001100". @@ -81,17 +81,17 @@ Parameters quick_sync (optional, dict, None) The settings for quick sync. - The *quick_sync* options are ignored if the quick sync hardware is not present. + The \ :emphasis:`quick\_sync`\ options are ignored if the quick sync hardware is not present. quick_sync_access (optional, str, None) - Users with administrator privileges can set the following types of *quick_sync_access*. + Users with administrator privileges can set the following types of \ :emphasis:`quick\_sync\_access`\ . - ``READ_WRITE`` enables writing configuration using quick sync. + \ :literal:`READ\_WRITE`\ enables writing configuration using quick sync. - ``READ_ONLY`` enables read only access to Wi-Fi and Bluetooth Low Energy(BLE). + \ :literal:`READ\_ONLY`\ enables read only access to Wi-Fi and Bluetooth Low Energy(BLE). - ``DISABLED`` disables reading or writing configuration through quick sync. + \ :literal:`DISABLED`\ disables reading or writing configuration through quick sync. enable_inactivity_timeout (optional, bool, None) @@ -103,17 +103,17 @@ Parameters The range is 120 to 3600 in seconds, or 2 to 60 in minutes. - This option is required when *enable_inactivity_timeout* is ``true``. + This option is required when \ :emphasis:`enable\_inactivity\_timeout`\ is \ :literal:`true`\ . timeout_limit_unit (optional, str, None) Inactivity timeout limit unit. - ``SECONDS`` to set *timeout_limit* in seconds. + \ :literal:`SECONDS`\ to set \ :emphasis:`timeout\_limit`\ in seconds. - ``MINUTES`` to set *timeout_limit* in minutes. + \ :literal:`MINUTES`\ to set \ :emphasis:`timeout\_limit`\ in minutes. - This option is required when *enable_inactivity_timeout* is ``true``. + This option is required when \ :emphasis:`enable\_inactivity\_timeout`\ is \ :literal:`true`\ . enable_read_authentication (optional, bool, None) @@ -128,17 +128,17 @@ Parameters lcd (optional, dict, None) The settings for LCD. - The *lcd* options are ignored if the LCD hardware is not present in the chassis. + The \ :emphasis:`lcd`\ options are ignored if the LCD hardware is not present in the chassis. lcd_access (optional, str, None) Option to configure the quick sync settings using LCD. - ``VIEW_AND_MODIFY`` to set access level to view and modify. + \ :literal:`VIEW\_AND\_MODIFY`\ to set access level to view and modify. - ``VIEW_ONLY`` to set access level to view. + \ :literal:`VIEW\_ONLY`\ to set access level to view. - ``DISABLED`` to disable the access. + \ :literal:`DISABLED`\ to disable the access. user_defined (optional, str, None) @@ -179,11 +179,11 @@ Parameters validate_certs (optional, bool, True) - If ``false``, the SSL certificates will not be validated. + If \ :literal:`false`\ , the SSL certificates will not be validated. - Configure ``false`` only on personally controlled sites where self-signed certificates are used. + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. - Prior to collection version ``5.0.0``, the *validate_certs* is ``false`` by default. + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. ca_path (optional, path, None) @@ -202,8 +202,8 @@ Notes .. note:: - Run this module from a system that has direct access to OpenManage Enterprise Modular. - - This module supports ``check_mode``. - - The module will always report change when *enable_chassis_power_button* is ``true``. + - This module supports \ :literal:`check\_mode`\ . + - The module will always report change when \ :emphasis:`enable\_chassis\_power\_button`\ is \ :literal:`true`\ . @@ -281,7 +281,7 @@ msg (always, str, Successfully updated the local access settings.) Overall status of the device local access settings. -location_details (success, dict, {'SettingType': 'LocalAccessConfiguration', 'EnableChassisDirect': False, 'EnableChassisPowerButton': False, 'EnableKvmAccess': True, 'EnableLcdOverridePin': False, 'LcdAccess': 'VIEW_ONLY', 'LcdCustomString': 'LCD Text', 'LcdLanguage': 'en', 'LcdOverridePin': '', 'LcdPinLength': None, 'LcdPresence': 'Present', 'LedPresence': None, 'QuickSync': {'EnableInactivityTimeout': True, 'EnableQuickSyncWifi': False, 'EnableReadAuthentication': False, 'QuickSyncAccess': 'READ_ONLY', 'QuickSyncHardware': 'Present', 'TimeoutLimit': 7, 'TimeoutLimitUnit': 'MINUTES'}}) +location_details (success, dict, {'SettingType': 'LocalAccessConfiguration', 'EnableChassisDirect': False, 'EnableChassisPowerButton': False, 'EnableKvmAccess': True, 'EnableLcdOverridePin': False, 'LcdAccess': 'VIEW_ONLY', 'LcdCustomString': 'LCD Text', 'LcdLanguage': 'en', 'LcdOverridePin': '', 'LcdPinLength': 6, 'LcdPresence': 'Present', 'LedPresence': 'Absent', 'QuickSync': {'EnableInactivityTimeout': True, 'EnableQuickSyncWifi': False, 'EnableReadAuthentication': False, 'QuickSyncAccess': 'READ_ONLY', 'QuickSyncHardware': 'Present', 'TimeoutLimit': 7, 'TimeoutLimitUnit': 'MINUTES'}}) returned when local access settings are updated successfully. diff --git a/ansible_collections/dellemc/openmanage/docs/modules/ome_device_quick_deploy.rst b/ansible_collections/dellemc/openmanage/docs/modules/ome_device_quick_deploy.rst index 185331335..6d1e1adf3 100644 --- a/ansible_collections/dellemc/openmanage/docs/modules/ome_device_quick_deploy.rst +++ b/ansible_collections/dellemc/openmanage/docs/modules/ome_device_quick_deploy.rst @@ -20,7 +20,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.9.6 +- python \>= 3.9.6 @@ -30,25 +30,25 @@ Parameters device_id (optional, int, None) The ID of the chassis for which the Quick Deploy settings to be deployed. - If the device ID is not specified, this module updates the Quick Deploy settings for the *hostname*. + If the device ID is not specified, this module updates the Quick Deploy settings for the \ :emphasis:`hostname`\ . - *device_id* is mutually exclusive with *device_service_tag*. + \ :emphasis:`device\_id`\ is mutually exclusive with \ :emphasis:`device\_service\_tag`\ . device_service_tag (optional, str, None) The service tag of the chassis for which the Quick Deploy settings to be deployed. - If the device service tag is not specified, this module updates the Quick Deploy settings for the *hostname*. + If the device service tag is not specified, this module updates the Quick Deploy settings for the \ :emphasis:`hostname`\ . - *device_service_tag* is mutually exclusive with *device_id*. + \ :emphasis:`device\_service\_tag`\ is mutually exclusive with \ :emphasis:`device\_id`\ . setting_type (True, str, None) The type of the Quick Deploy settings to be applied. - ``ServerQuickDeploy`` to apply the server Quick Deploy settings. + \ :literal:`ServerQuickDeploy`\ to apply the server Quick Deploy settings. - ``IOMQuickDeploy`` to apply the IOM Quick Deploy settings. + \ :literal:`IOMQuickDeploy`\ to apply the IOM Quick Deploy settings. job_wait (optional, bool, True) @@ -56,9 +56,9 @@ Parameters job_wait_timeout (optional, int, 120) - The maximum wait time of *job_wait* in seconds. The job is tracked only for this duration. + The maximum wait time of \ :emphasis:`job\_wait`\ in seconds. The job is tracked only for this duration. - This option is applicable when *job_wait* is ``true``. + This option is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ . quick_deploy_options (True, dict, None) @@ -68,7 +68,7 @@ Parameters password (optional, str, None) The password to login to the server or IOM. - The module will always report change when *password* option is added. + The module will always report change when \ :emphasis:`password`\ option is added. ipv4_enabled (optional, bool, None) @@ -78,23 +78,23 @@ Parameters ipv4_network_type (optional, str, None) IPv4 network type. - *ipv4_network_type* is required if *ipv4_enabled* is ``true``. + \ :emphasis:`ipv4\_network\_type`\ is required if \ :emphasis:`ipv4\_enabled`\ is \ :literal:`true`\ . - ``Static`` to configure the static IP settings. + \ :literal:`Static`\ to configure the static IP settings. - ``DHCP`` to configure the Dynamic IP settings. + \ :literal:`DHCP`\ to configure the Dynamic IP settings. ipv4_subnet_mask (optional, str, None) IPv4 subnet mask. - *ipv4_subnet_mask* is required if *ipv4_network_type* is ``Static``. + \ :emphasis:`ipv4\_subnet\_mask`\ is required if \ :emphasis:`ipv4\_network\_type`\ is \ :literal:`Static`\ . ipv4_gateway (optional, str, None) IPv4 gateway. - *ipv4_gateway* is required if *ipv4_network_type* is ``Static``. + \ :emphasis:`ipv4\_gateway`\ is required if \ :emphasis:`ipv4\_network\_type`\ is \ :literal:`Static`\ . ipv6_enabled (optional, bool, None) @@ -104,23 +104,23 @@ Parameters ipv6_network_type (optional, str, None) IPv6 network type. - *ipv6_network_type* is required if *ipv6_enabled* is ``true``. + \ :emphasis:`ipv6\_network\_type`\ is required if \ :emphasis:`ipv6\_enabled`\ is \ :literal:`true`\ . - ``Static`` to configure the static IP settings. + \ :literal:`Static`\ to configure the static IP settings. - ``DHCP`` to configure the Dynamic IP settings. + \ :literal:`DHCP`\ to configure the Dynamic IP settings. ipv6_prefix_length (optional, int, None) IPV6 prefix length. - *ipv6_prefix_length* is required if *ipv6_network_type* is ``Static``. + \ :emphasis:`ipv6\_prefix\_length`\ is required if \ :emphasis:`ipv6\_network\_type`\ is \ :literal:`Static`\ . ipv6_gateway (optional, str, None) IPv6 gateway. - *ipv6_gateway* is required if *ipv6_network_type* is ``Static``. + \ :emphasis:`ipv6\_gateway`\ is required if \ :emphasis:`ipv6\_network\_type`\ is \ :literal:`Static`\ . slots (optional, list, None) @@ -152,21 +152,29 @@ Parameters username (True, str, None) OpenManage Enterprise Modular username. + If the username is not provided, then the environment variable \ :literal:`OME\_USERNAME`\ is used. + + Example: export OME\_USERNAME=username + password (True, str, None) OpenManage Enterprise Modular password. + If the password is not provided, then the environment variable \ :literal:`OME\_PASSWORD`\ is used. + + Example: export OME\_PASSWORD=password + port (optional, int, 443) OpenManage Enterprise Modular HTTPS port. validate_certs (optional, bool, True) - If ``false``, the SSL certificates will not be validated. + If \ :literal:`false`\ , the SSL certificates will not be validated. - Configure ``false`` only on personally controlled sites where self-signed certificates are used. + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. - Prior to collection version ``5.0.0``, the *validate_certs* is ``false`` by default. + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. ca_path (optional, path, None) @@ -185,8 +193,8 @@ Notes .. note:: - Run this module from a system that has direct access to OpenManage Enterprise Modular. - - This module supports ``check_mode``. - - The module will always report change when *password* option is added. + - This module supports \ :literal:`check\_mode`\ . + - The module will always report change when \ :emphasis:`password`\ option is added. - If the chassis is a member of a multi-chassis group and it is assigned as a backup lead chassis, the operations performed on the chassis using this module may conflict with the management operations performed on the chassis through the lead chassis. @@ -291,4 +299,5 @@ Authors - Felix Stephen (@felixs88) - Shivam Sharma (@ShivamSh3) +- Kritika Bhateja (@Kritika-Bhateja-03) diff --git a/ansible_collections/dellemc/openmanage/docs/modules/ome_devices.rst b/ansible_collections/dellemc/openmanage/docs/modules/ome_devices.rst index 756adde24..b1d56a045 100644 --- a/ansible_collections/dellemc/openmanage/docs/modules/ome_devices.rst +++ b/ansible_collections/dellemc/openmanage/docs/modules/ome_devices.rst @@ -20,7 +20,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.8.6 +- python \>= 3.9.6 @@ -30,27 +30,27 @@ Parameters device_service_tags (optional, list, None) Service tag of the target devices. - This is mutually exclusive with *device_ids*. + This is mutually exclusive with \ :emphasis:`device\_ids`\ . device_ids (optional, list, None) IDs of the target devices. - This is mutually exclusive with *device_service_tags*. + This is mutually exclusive with \ :emphasis:`device\_service\_tags`\ . state (optional, str, present) - ``present`` Allows to perform the *device_action* on the target devices. + \ :literal:`present`\ Allows to perform the \ :emphasis:`device\_action`\ on the target devices. - ``absent`` Removes the device from OpenManage Enterprise. Job is not triggered. *job_wait*, *job_schedule*, *job_name*, and *job_description* are not applicable to this operation. + \ :literal:`absent`\ Removes the device from OpenManage Enterprise. Job is not triggered. \ :emphasis:`job\_wait`\ , \ :emphasis:`job\_schedule`\ , \ :emphasis:`job\_name`\ , and \ :emphasis:`job\_description`\ are not applicable to this operation. device_action (optional, str, refresh_inventory) - ``refresh_inventory`` refreshes the inventory on the target devices. + \ :literal:`refresh\_inventory`\ refreshes the inventory on the target devices. - ``reset_idrac`` Triggers a reset on the target iDRACs. + \ :literal:`reset\_idrac`\ Triggers a reset on the target iDRACs. - ``clear_idrac_job_queue`` Clears the job queue on the target iDRACs. + \ :literal:`clear\_idrac\_job\_queue`\ Clears the job queue on the target iDRACs. A job is triggered for each action. @@ -58,15 +58,15 @@ Parameters job_wait (optional, bool, True) Provides an option to wait for the job completion. - This option is applicable when *state* is ``present``. + This option is applicable when \ :emphasis:`state`\ is \ :literal:`present`\ . - This is applicable when *job_schedule* is ``startnow``. + This is applicable when \ :emphasis:`job\_schedule`\ is \ :literal:`startnow`\ . job_wait_timeout (optional, int, 1200) - The maximum wait time of *job_wait* in seconds. The job is tracked only for this duration. + The maximum wait time of \ :emphasis:`job\_wait`\ in seconds. The job is tracked only for this duration. - This option is applicable when *job_wait* is ``true``. + This option is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ . job_schedule (optional, str, startnow) @@ -98,11 +98,11 @@ Parameters validate_certs (optional, bool, True) - If ``false``, the SSL certificates will not be validated. + If \ :literal:`false`\ , the SSL certificates will not be validated. - Configure ``false`` only on personally controlled sites where self-signed certificates are used. + Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used. - Prior to collection version ``5.0.0``, the *validate_certs* is ``false`` by default. + Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default. ca_path (optional, path, None) @@ -120,9 +120,9 @@ Notes ----- .. note:: - - For ``idrac_reset``, the job triggers only the iDRAC reset operation and does not track the complete reset cycle. + - For \ :literal:`idrac\_reset`\ , the job triggers only the iDRAC reset operation and does not track the complete reset cycle. - Run this module from a system that has direct access to Dell OpenManage Enterprise. - - This module supports ``check_mode``. + - This module supports \ :literal:`check\_mode`\ . @@ -216,4 +216,5 @@ Authors ~~~~~~~ - Jagadeesh N V(@jagadeeshnv) +- ShivamSh3(@ShivamSh3) diff --git a/ansible_collections/dellemc/openmanage/docs/modules/redfish_storage_volume.rst b/ansible_collections/dellemc/openmanage/docs/modules/redfish_storage_volume.rst index f6e5f577f..c349b7d99 100644 --- a/ansible_collections/dellemc/openmanage/docs/modules/redfish_storage_volume.rst +++ b/ansible_collections/dellemc/openmanage/docs/modules/redfish_storage_volume.rst @@ -227,6 +227,7 @@ Notes - Run this module from a system that has direct access to Redfish APIs. - This module supports \ :literal:`check\_mode`\ . - This module always reports changes when \ :emphasis:`name`\ and \ :emphasis:`volume\_id`\ are not specified. Either \ :emphasis:`name`\ or \ :emphasis:`volume\_id`\ is required to support \ :literal:`check\_mode`\ . + - This module does not support the create operation of RAID6 and RAID60 storage volume on iDRAC8 - This module supports IPv4 and IPv6 addresses. @@ -405,4 +406,5 @@ Authors - Sajna Shetty(@Sajna-Shetty) - Kritika Bhateja(@Kritika-Bhateja-03) +- Shivam Sharma(@ShivamSh3) |