Skip to content

Commit abde3b5

Browse files
authored
Merge pull request #637 from Kritika-Bhateja-03/issue/defect_fix
Issue/defect fix
2 parents bec15d3 + f890fc2 commit abde3b5

File tree

2 files changed

+35
-28
lines changed

2 files changed

+35
-28
lines changed

docs/modules/ome_device_quick_deploy.rst

+34-25
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Requirements
2020
------------
2121
The below requirements are needed on the host that executes this module.
2222

23-
- python >= 3.9.6
23+
- python \>= 3.9.6
2424

2525

2626

@@ -30,35 +30,35 @@ Parameters
3030
device_id (optional, int, None)
3131
The ID of the chassis for which the Quick Deploy settings to be deployed.
3232

33-
If the device ID is not specified, this module updates the Quick Deploy settings for the *hostname*.
33+
If the device ID is not specified, this module updates the Quick Deploy settings for the \ :emphasis:`hostname`\ .
3434

35-
*device_id* is mutually exclusive with *device_service_tag*.
35+
\ :emphasis:`device\_id`\ is mutually exclusive with \ :emphasis:`device\_service\_tag`\ .
3636

3737

3838
device_service_tag (optional, str, None)
3939
The service tag of the chassis for which the Quick Deploy settings to be deployed.
4040

41-
If the device service tag is not specified, this module updates the Quick Deploy settings for the *hostname*.
41+
If the device service tag is not specified, this module updates the Quick Deploy settings for the \ :emphasis:`hostname`\ .
4242

43-
*device_service_tag* is mutually exclusive with *device_id*.
43+
\ :emphasis:`device\_service\_tag`\ is mutually exclusive with \ :emphasis:`device\_id`\ .
4444

4545

4646
setting_type (True, str, None)
4747
The type of the Quick Deploy settings to be applied.
4848

49-
``ServerQuickDeploy`` to apply the server Quick Deploy settings.
49+
\ :literal:`ServerQuickDeploy`\ to apply the server Quick Deploy settings.
5050

51-
``IOMQuickDeploy`` to apply the IOM Quick Deploy settings.
51+
\ :literal:`IOMQuickDeploy`\ to apply the IOM Quick Deploy settings.
5252

5353

5454
job_wait (optional, bool, True)
5555
Determines whether to wait for the job completion or not.
5656

5757

5858
job_wait_timeout (optional, int, 120)
59-
The maximum wait time of *job_wait* in seconds. The job is tracked only for this duration.
59+
The maximum wait time of \ :emphasis:`job\_wait`\ in seconds. The job is tracked only for this duration.
6060

61-
This option is applicable when *job_wait* is ``true``.
61+
This option is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ .
6262

6363

6464
quick_deploy_options (True, dict, None)
@@ -68,7 +68,7 @@ Parameters
6868
password (optional, str, None)
6969
The password to login to the server or IOM.
7070

71-
The module will always report change when *password* option is added.
71+
The module will always report change when \ :emphasis:`password`\ option is added.
7272

7373

7474
ipv4_enabled (optional, bool, None)
@@ -78,23 +78,23 @@ Parameters
7878
ipv4_network_type (optional, str, None)
7979
IPv4 network type.
8080

81-
*ipv4_network_type* is required if *ipv4_enabled* is ``true``.
81+
\ :emphasis:`ipv4\_network\_type`\ is required if \ :emphasis:`ipv4\_enabled`\ is \ :literal:`true`\ .
8282

83-
``Static`` to configure the static IP settings.
83+
\ :literal:`Static`\ to configure the static IP settings.
8484

85-
``DHCP`` to configure the Dynamic IP settings.
85+
\ :literal:`DHCP`\ to configure the Dynamic IP settings.
8686

8787

8888
ipv4_subnet_mask (optional, str, None)
8989
IPv4 subnet mask.
9090

91-
*ipv4_subnet_mask* is required if *ipv4_network_type* is ``Static``.
91+
\ :emphasis:`ipv4\_subnet\_mask`\ is required if \ :emphasis:`ipv4\_network\_type`\ is \ :literal:`Static`\ .
9292

9393

9494
ipv4_gateway (optional, str, None)
9595
IPv4 gateway.
9696

97-
*ipv4_gateway* is required if *ipv4_network_type* is ``Static``.
97+
\ :emphasis:`ipv4\_gateway`\ is required if \ :emphasis:`ipv4\_network\_type`\ is \ :literal:`Static`\ .
9898

9999

100100
ipv6_enabled (optional, bool, None)
@@ -104,23 +104,23 @@ Parameters
104104
ipv6_network_type (optional, str, None)
105105
IPv6 network type.
106106

107-
*ipv6_network_type* is required if *ipv6_enabled* is ``true``.
107+
\ :emphasis:`ipv6\_network\_type`\ is required if \ :emphasis:`ipv6\_enabled`\ is \ :literal:`true`\ .
108108

109-
``Static`` to configure the static IP settings.
109+
\ :literal:`Static`\ to configure the static IP settings.
110110

111-
``DHCP`` to configure the Dynamic IP settings.
111+
\ :literal:`DHCP`\ to configure the Dynamic IP settings.
112112

113113

114114
ipv6_prefix_length (optional, int, None)
115115
IPV6 prefix length.
116116

117-
*ipv6_prefix_length* is required if *ipv6_network_type* is ``Static``.
117+
\ :emphasis:`ipv6\_prefix\_length`\ is required if \ :emphasis:`ipv6\_network\_type`\ is \ :literal:`Static`\ .
118118

119119

120120
ipv6_gateway (optional, str, None)
121121
IPv6 gateway.
122122

123-
*ipv6_gateway* is required if *ipv6_network_type* is ``Static``.
123+
\ :emphasis:`ipv6\_gateway`\ is required if \ :emphasis:`ipv6\_network\_type`\ is \ :literal:`Static`\ .
124124

125125

126126
slots (optional, list, None)
@@ -152,21 +152,29 @@ Parameters
152152
username (True, str, None)
153153
OpenManage Enterprise Modular username.
154154

155+
If the username is not provided, then the environment variable \ :literal:`OME\_USERNAME`\ is used.
156+
157+
Example: export OME\_USERNAME=username
158+
155159

156160
password (True, str, None)
157161
OpenManage Enterprise Modular password.
158162

163+
If the password is not provided, then the environment variable \ :literal:`OME\_PASSWORD`\ is used.
164+
165+
Example: export OME\_PASSWORD=password
166+
159167

160168
port (optional, int, 443)
161169
OpenManage Enterprise Modular HTTPS port.
162170

163171

164172
validate_certs (optional, bool, True)
165-
If ``false``, the SSL certificates will not be validated.
173+
If \ :literal:`false`\ , the SSL certificates will not be validated.
166174

167-
Configure ``false`` only on personally controlled sites where self-signed certificates are used.
175+
Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used.
168176

169-
Prior to collection version ``5.0.0``, the *validate_certs* is ``false`` by default.
177+
Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default.
170178

171179

172180
ca_path (optional, path, None)
@@ -185,8 +193,8 @@ Notes
185193

186194
.. note::
187195
- Run this module from a system that has direct access to OpenManage Enterprise Modular.
188-
- This module supports ``check_mode``.
189-
- The module will always report change when *password* option is added.
196+
- This module supports \ :literal:`check\_mode`\ .
197+
- The module will always report change when \ :emphasis:`password`\ option is added.
190198
- 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.
191199

192200

@@ -291,4 +299,5 @@ Authors
291299

292300
- Felix Stephen (@felixs88)
293301
- Shivam Sharma (@ShivamSh3)
302+
- Kritika Bhateja (@Kritika-Bhateja-03)
294303

plugins/modules/ome_device_quick_deploy.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
#
55
# Dell OpenManage Ansible Modules
6-
# Version 8.7.0
6+
# Version 9.1.0
77
# Copyright (C) 2022-2024 Dell Inc. or its subsidiaries. All Rights Reserved.
88

99
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -470,8 +470,6 @@ def check_mode_validation(module, deploy_data):
470470
"SlotIPV6Address": each.get("slot_ipv6_address"), "VlanId": each.get("vlan_id")}
471471
if each.get("vlan_id") is not None:
472472
req_slot_1.update({"VlanId": str(each.get("vlan_id"))})
473-
else:
474-
req_slot_1.update({"VlanId": ""})
475473
req_filter_slot = dict([(k, v) for k, v in req_slot_1.items() if v is not None])
476474
exist_slot_1 = {"SlotId": exist_filter_slot[0].get("SlotId"),
477475
"SlotIPV4Address": exist_filter_slot[0].get("SlotIPV4Address"),

0 commit comments

Comments
 (0)