You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/modules/ome_device_quick_deploy.rst
+34-25
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Requirements
20
20
------------
21
21
The below requirements are needed on the host that executes this module.
22
22
23
-
- python >= 3.9.6
23
+
- python \>= 3.9.6
24
24
25
25
26
26
@@ -30,35 +30,35 @@ Parameters
30
30
device_id (optional, int, None)
31
31
The ID of the chassis for which the Quick Deploy settings to be deployed.
32
32
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`\ .
34
34
35
-
*device_id* is mutually exclusive with *device_service_tag*.
35
+
\ :emphasis:`device\_id`\ is mutually exclusive with \ :emphasis:`device\_service\_tag`\ .
36
36
37
37
38
38
device_service_tag (optional, str, None)
39
39
The service tag of the chassis for which the Quick Deploy settings to be deployed.
40
40
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`\ .
42
42
43
-
*device_service_tag* is mutually exclusive with *device_id*.
43
+
\ :emphasis:`device\_service\_tag`\ is mutually exclusive with \ :emphasis:`device\_id`\ .
44
44
45
45
46
46
setting_type (True, str, None)
47
47
The type of the Quick Deploy settings to be applied.
48
48
49
-
``ServerQuickDeploy`` to apply the server Quick Deploy settings.
49
+
\ :literal:`ServerQuickDeploy`\ to apply the server Quick Deploy settings.
50
50
51
-
``IOMQuickDeploy`` to apply the IOM Quick Deploy settings.
51
+
\ :literal:`IOMQuickDeploy`\ to apply the IOM Quick Deploy settings.
52
52
53
53
54
54
job_wait (optional, bool, True)
55
55
Determines whether to wait for the job completion or not.
56
56
57
57
58
58
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.
60
60
61
-
This option is applicable when *job_wait* is ``true``.
61
+
This option is applicable when \ :emphasis:`job\_wait`\ is \ :literal:`true`\ .
62
62
63
63
64
64
quick_deploy_options (True, dict, None)
@@ -68,7 +68,7 @@ Parameters
68
68
password (optional, str, None)
69
69
The password to login to the server or IOM.
70
70
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.
72
72
73
73
74
74
ipv4_enabled (optional, bool, None)
@@ -78,23 +78,23 @@ Parameters
78
78
ipv4_network_type (optional, str, None)
79
79
IPv4 network type.
80
80
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`\ .
82
82
83
-
``Static`` to configure the static IP settings.
83
+
\ :literal:`Static`\ to configure the static IP settings.
84
84
85
-
``DHCP`` to configure the Dynamic IP settings.
85
+
\ :literal:`DHCP`\ to configure the Dynamic IP settings.
86
86
87
87
88
88
ipv4_subnet_mask (optional, str, None)
89
89
IPv4 subnet mask.
90
90
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`\ .
92
92
93
93
94
94
ipv4_gateway (optional, str, None)
95
95
IPv4 gateway.
96
96
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`\ .
98
98
99
99
100
100
ipv6_enabled (optional, bool, None)
@@ -104,23 +104,23 @@ Parameters
104
104
ipv6_network_type (optional, str, None)
105
105
IPv6 network type.
106
106
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`\ .
108
108
109
-
``Static`` to configure the static IP settings.
109
+
\ :literal:`Static`\ to configure the static IP settings.
110
110
111
-
``DHCP`` to configure the Dynamic IP settings.
111
+
\ :literal:`DHCP`\ to configure the Dynamic IP settings.
112
112
113
113
114
114
ipv6_prefix_length (optional, int, None)
115
115
IPV6 prefix length.
116
116
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`\ .
118
118
119
119
120
120
ipv6_gateway (optional, str, None)
121
121
IPv6 gateway.
122
122
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`\ .
124
124
125
125
126
126
slots (optional, list, None)
@@ -152,21 +152,29 @@ Parameters
152
152
username (True, str, None)
153
153
OpenManage Enterprise Modular username.
154
154
155
+
If the username is not provided, then the environment variable \ :literal:`OME\_USERNAME`\ is used.
156
+
157
+
Example: export OME\_USERNAME=username
158
+
155
159
156
160
password (True, str, None)
157
161
OpenManage Enterprise Modular password.
158
162
163
+
If the password is not provided, then the environment variable \ :literal:`OME\_PASSWORD`\ is used.
164
+
165
+
Example: export OME\_PASSWORD=password
166
+
159
167
160
168
port (optional, int, 443)
161
169
OpenManage Enterprise Modular HTTPS port.
162
170
163
171
164
172
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.
166
174
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.
168
176
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.
170
178
171
179
172
180
ca_path (optional, path, None)
@@ -185,8 +193,8 @@ Notes
185
193
186
194
.. note::
187
195
- 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.
190
198
- 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.
0 commit comments