1.. Document meta 2 3:orphan: 4 5.. Anchors 6 7.. _ansible_collections.inspur.sm.edit_ldisk_module: 8 9.. Anchors: short name for ansible.builtin 10 11.. Anchors: aliases 12 13 14 15.. Title 16 17inspur.sm.edit_ldisk -- Set logical disk. 18+++++++++++++++++++++++++++++++++++++++++ 19 20.. Collection note 21 22.. note:: 23 This plugin is part of the `inspur.sm collection <https://galaxy.ansible.com/inspur/sm>`_. 24 25 To install it use: :code:`ansible-galaxy collection install inspur.sm`. 26 27 To use it in a playbook, specify: :code:`inspur.sm.edit_ldisk`. 28 29.. version_added 30 31.. versionadded:: 0.1.0 of inspur.sm 32 33.. contents:: 34 :local: 35 :depth: 1 36 37.. Deprecated 38 39 40Synopsis 41-------- 42 43.. Description 44 45- Set logical disk on Inspur server. 46 47.. Aliases 48 49 50.. Requirements 51 52 53.. Options 54 55Parameters 56---------- 57 58.. raw:: html 59 60 <table border=0 cellpadding=0 class="documentation-table"> 61 <tr> 62 <th colspan="2">Parameter</th> 63 <th>Choices/<font color="blue">Defaults</font></th> 64 <th width="100%">Comments</th> 65 </tr> 66 <tr> 67 <td colspan="2"> 68 <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div> 69 <b>ctrl_id</b> 70 <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a> 71 <div style="font-size: small"> 72 <span style="color: purple">integer</span> 73 </div> 74 </td> 75 <td> 76 </td> 77 <td> 78 <div>Raid controller ID.</div> 79 <div>Required when <em>Info=None</em>.</div> 80 </td> 81 </tr> 82 <tr> 83 <td colspan="2"> 84 <div class="ansibleOptionAnchor" id="parameter-host"></div> 85 <b>host</b> 86 <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> 87 <div style="font-size: small"> 88 <span style="color: purple">string</span> 89 </div> 90 </td> 91 <td> 92 </td> 93 <td> 94 <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> 95 </td> 96 </tr> 97 <tr> 98 <td colspan="2"> 99 <div class="ansibleOptionAnchor" id="parameter-info"></div> 100 <b>info</b> 101 <a class="ansibleOptionLink" href="#parameter-info" title="Permalink to this option"></a> 102 <div style="font-size: small"> 103 <span style="color: purple">string</span> 104 </div> 105 </td> 106 <td> 107 <ul style="margin: 0; padding: 0"><b>Choices:</b> 108 <li>show</li> 109 </ul> 110 </td> 111 <td> 112 <div>Show controller and ldisk info.</div> 113 </td> 114 </tr> 115 <tr> 116 <td colspan="2"> 117 <div class="ansibleOptionAnchor" id="parameter-ldisk_id"></div> 118 <b>ldisk_id</b> 119 <a class="ansibleOptionLink" href="#parameter-ldisk_id" title="Permalink to this option"></a> 120 <div style="font-size: small"> 121 <span style="color: purple">integer</span> 122 </div> 123 </td> 124 <td> 125 </td> 126 <td> 127 <div>Logical disk ID.</div> 128 <div>Required when <em>Info=None</em>.</div> 129 </td> 130 </tr> 131 <tr> 132 <td colspan="2"> 133 <div class="ansibleOptionAnchor" id="parameter-option"></div> 134 <b>option</b> 135 <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a> 136 <div style="font-size: small"> 137 <span style="color: purple">string</span> 138 </div> 139 </td> 140 <td> 141 <ul style="margin: 0; padding: 0"><b>Choices:</b> 142 <li>LOC</li> 143 <li>STL</li> 144 <li>FI</li> 145 <li>SFI</li> 146 <li>SI</li> 147 <li>DEL</li> 148 </ul> 149 </td> 150 <td> 151 <div>Set operation options fo logical disk,</div> 152 <div>LOC is Locate Logical Drive,STL is Stop Locate LogicalDrive,</div> 153 <div>FI is Fast Initialization,SFI is Slow/Full Initialization,</div> 154 <div>SI is Stop Initialization,DEL is Delete LogicalDrive.</div> 155 <div>Required when <em>Info=None</em>.</div> 156 </td> 157 </tr> 158 <tr> 159 <td colspan="2"> 160 <div class="ansibleOptionAnchor" id="parameter-password"></div> 161 <b>password</b> 162 <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> 163 <div style="font-size: small"> 164 <span style="color: purple">string</span> 165 </div> 166 </td> 167 <td> 168 </td> 169 <td> 170 <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> 171 </td> 172 </tr> 173 <tr> 174 <td colspan="2"> 175 <div class="ansibleOptionAnchor" id="parameter-provider"></div> 176 <b>provider</b> 177 <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> 178 <div style="font-size: small"> 179 <span style="color: purple">dictionary</span> 180 </div> 181 </td> 182 <td> 183 </td> 184 <td> 185 <div>A dict object containing connection details.</div> 186 </td> 187 </tr> 188 <tr> 189 <td class="elbow-placeholder"></td> 190 <td colspan="1"> 191 <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> 192 <b>host</b> 193 <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> 194 <div style="font-size: small"> 195 <span style="color: purple">string</span> 196 </div> 197 </td> 198 <td> 199 </td> 200 <td> 201 <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> 202 </td> 203 </tr> 204 <tr> 205 <td class="elbow-placeholder"></td> 206 <td colspan="1"> 207 <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> 208 <b>password</b> 209 <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> 210 <div style="font-size: small"> 211 <span style="color: purple">string</span> 212 </div> 213 </td> 214 <td> 215 </td> 216 <td> 217 <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> 218 </td> 219 </tr> 220 <tr> 221 <td class="elbow-placeholder"></td> 222 <td colspan="1"> 223 <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> 224 <b>username</b> 225 <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> 226 <div style="font-size: small"> 227 <span style="color: purple">string</span> 228 </div> 229 </td> 230 <td> 231 </td> 232 <td> 233 <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> 234 </td> 235 </tr> 236 237 <tr> 238 <td colspan="2"> 239 <div class="ansibleOptionAnchor" id="parameter-username"></div> 240 <b>username</b> 241 <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> 242 <div style="font-size: small"> 243 <span style="color: purple">string</span> 244 </div> 245 </td> 246 <td> 247 </td> 248 <td> 249 <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> 250 </td> 251 </tr> 252 </table> 253 <br/> 254 255.. Notes 256 257 258.. Seealso 259 260 261.. Examples 262 263Examples 264-------- 265 266.. code-block:: yaml+jinja 267 268 269 - name: Edit ldisk test 270 hosts: ism 271 connection: local 272 gather_facts: no 273 vars: 274 ism: 275 host: "{{ ansible_ssh_host }}" 276 username: "{{ username }}" 277 password: "{{ password }}" 278 279 tasks: 280 281 - name: "Show ldisk information" 282 inspur.sm.edit_ldisk: 283 info: "show" 284 provider: "{{ ism }}" 285 286 - name: "Edit ldisk" 287 inspur.sm.edit_ldisk: 288 ctrl_id: 0 289 ldisk_id: 1 290 option: "LOC" 291 provider: "{{ ism }}" 292 293 294 295 296.. Facts 297 298 299.. Return values 300 301Return Values 302------------- 303Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: 304 305.. raw:: html 306 307 <table border=0 cellpadding=0 class="documentation-table"> 308 <tr> 309 <th colspan="1">Key</th> 310 <th>Returned</th> 311 <th width="100%">Description</th> 312 </tr> 313 <tr> 314 <td colspan="1"> 315 <div class="ansibleOptionAnchor" id="return-changed"></div> 316 <b>changed</b> 317 <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> 318 <div style="font-size: small"> 319 <span style="color: purple">boolean</span> 320 </div> 321 </td> 322 <td>always</td> 323 <td> 324 <div>Check to see if a change was made on the device.</div> 325 <br/> 326 </td> 327 </tr> 328 <tr> 329 <td colspan="1"> 330 <div class="ansibleOptionAnchor" id="return-message"></div> 331 <b>message</b> 332 <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> 333 <div style="font-size: small"> 334 <span style="color: purple">string</span> 335 </div> 336 </td> 337 <td>always</td> 338 <td> 339 <div>Messages returned after module execution.</div> 340 <br/> 341 </td> 342 </tr> 343 <tr> 344 <td colspan="1"> 345 <div class="ansibleOptionAnchor" id="return-state"></div> 346 <b>state</b> 347 <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> 348 <div style="font-size: small"> 349 <span style="color: purple">string</span> 350 </div> 351 </td> 352 <td>always</td> 353 <td> 354 <div>Status after module execution.</div> 355 <br/> 356 </td> 357 </tr> 358 </table> 359 <br/><br/> 360 361.. Status (Presently only deprecated) 362 363 364.. Authors 365 366Authors 367~~~~~~~ 368 369- WangBaoshan (@ISIB-group) 370 371 372 373.. Parsing errors 374 375