1.. Document meta 2 3:orphan: 4 5.. Anchors 6 7.. _ansible_collections.inspur.sm.edit_connect_media_module: 8 9.. Anchors: short name for ansible.builtin 10 11.. Anchors: aliases 12 13 14 15.. Title 16 17inspur.sm.edit_connect_media -- Start/Stop virtual media Image 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_connect_media`. 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- Start/Stop virtual media Image 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-host"></div> 69 <b>host</b> 70 <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> 71 <div style="font-size: small"> 72 <span style="color: purple">string</span> 73 </div> 74 </td> 75 <td> 76 </td> 77 <td> 78 <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> 79 </td> 80 </tr> 81 <tr> 82 <td colspan="2"> 83 <div class="ansibleOptionAnchor" id="parameter-image_name"></div> 84 <b>image_name</b> 85 <a class="ansibleOptionLink" href="#parameter-image_name" title="Permalink to this option"></a> 86 <div style="font-size: small"> 87 <span style="color: purple">string</span> 88 / <span style="color: red">required</span> </div> 89 </td> 90 <td> 91 </td> 92 <td> 93 <div>Image name.</div> 94 </td> 95 </tr> 96 <tr> 97 <td colspan="2"> 98 <div class="ansibleOptionAnchor" id="parameter-image_type"></div> 99 <b>image_type</b> 100 <a class="ansibleOptionLink" href="#parameter-image_type" title="Permalink to this option"></a> 101 <div style="font-size: small"> 102 <span style="color: purple">string</span> 103 / <span style="color: red">required</span> </div> 104 </td> 105 <td> 106 <ul style="margin: 0; padding: 0"><b>Choices:</b> 107 <li>CD</li> 108 <li>FD</li> 109 <li>HD</li> 110 </ul> 111 </td> 112 <td> 113 <div>Virtual media type.</div> 114 <div>Only the M5 model supports this parameter.</div> 115 </td> 116 </tr> 117 <tr> 118 <td colspan="2"> 119 <div class="ansibleOptionAnchor" id="parameter-op_type"></div> 120 <b>op_type</b> 121 <a class="ansibleOptionLink" href="#parameter-op_type" title="Permalink to this option"></a> 122 <div style="font-size: small"> 123 <span style="color: purple">string</span> 124 / <span style="color: red">required</span> </div> 125 </td> 126 <td> 127 <ul style="margin: 0; padding: 0"><b>Choices:</b> 128 <li>start</li> 129 <li>stop</li> 130 </ul> 131 </td> 132 <td> 133 <div>Start or stop media.</div> 134 </td> 135 </tr> 136 <tr> 137 <td colspan="2"> 138 <div class="ansibleOptionAnchor" id="parameter-password"></div> 139 <b>password</b> 140 <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> 141 <div style="font-size: small"> 142 <span style="color: purple">string</span> 143 </div> 144 </td> 145 <td> 146 </td> 147 <td> 148 <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> 149 </td> 150 </tr> 151 <tr> 152 <td colspan="2"> 153 <div class="ansibleOptionAnchor" id="parameter-provider"></div> 154 <b>provider</b> 155 <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> 156 <div style="font-size: small"> 157 <span style="color: purple">dictionary</span> 158 </div> 159 </td> 160 <td> 161 </td> 162 <td> 163 <div>A dict object containing connection details.</div> 164 </td> 165 </tr> 166 <tr> 167 <td class="elbow-placeholder"></td> 168 <td colspan="1"> 169 <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> 170 <b>host</b> 171 <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> 172 <div style="font-size: small"> 173 <span style="color: purple">string</span> 174 </div> 175 </td> 176 <td> 177 </td> 178 <td> 179 <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> 180 </td> 181 </tr> 182 <tr> 183 <td class="elbow-placeholder"></td> 184 <td colspan="1"> 185 <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> 186 <b>password</b> 187 <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> 188 <div style="font-size: small"> 189 <span style="color: purple">string</span> 190 </div> 191 </td> 192 <td> 193 </td> 194 <td> 195 <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> 196 </td> 197 </tr> 198 <tr> 199 <td class="elbow-placeholder"></td> 200 <td colspan="1"> 201 <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> 202 <b>username</b> 203 <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> 204 <div style="font-size: small"> 205 <span style="color: purple">string</span> 206 </div> 207 </td> 208 <td> 209 </td> 210 <td> 211 <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> 212 </td> 213 </tr> 214 215 <tr> 216 <td colspan="2"> 217 <div class="ansibleOptionAnchor" id="parameter-username"></div> 218 <b>username</b> 219 <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> 220 <div style="font-size: small"> 221 <span style="color: purple">string</span> 222 </div> 223 </td> 224 <td> 225 </td> 226 <td> 227 <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> 228 </td> 229 </tr> 230 </table> 231 <br/> 232 233.. Notes 234 235 236.. Seealso 237 238 239.. Examples 240 241Examples 242-------- 243 244.. code-block:: yaml+jinja 245 246 247 - name: Connect media test 248 hosts: ism 249 connection: local 250 gather_facts: no 251 vars: 252 ism: 253 host: "{{ ansible_ssh_host }}" 254 username: "{{ username }}" 255 password: "{{ password }}" 256 257 tasks: 258 259 - name: "Set remote image redirection" 260 inspur.sm.edit_connect_media: 261 image_type: "CD" 262 op_type: "start" 263 image_name: "aa.iso" 264 provider: "{{ ism }}" 265 266 267 268 269.. Facts 270 271 272.. Return values 273 274Return Values 275------------- 276Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: 277 278.. raw:: html 279 280 <table border=0 cellpadding=0 class="documentation-table"> 281 <tr> 282 <th colspan="1">Key</th> 283 <th>Returned</th> 284 <th width="100%">Description</th> 285 </tr> 286 <tr> 287 <td colspan="1"> 288 <div class="ansibleOptionAnchor" id="return-changed"></div> 289 <b>changed</b> 290 <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> 291 <div style="font-size: small"> 292 <span style="color: purple">boolean</span> 293 </div> 294 </td> 295 <td>always</td> 296 <td> 297 <div>Check to see if a change was made on the device.</div> 298 <br/> 299 </td> 300 </tr> 301 <tr> 302 <td colspan="1"> 303 <div class="ansibleOptionAnchor" id="return-message"></div> 304 <b>message</b> 305 <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> 306 <div style="font-size: small"> 307 <span style="color: purple">string</span> 308 </div> 309 </td> 310 <td>always</td> 311 <td> 312 <div>Messages returned after module execution.</div> 313 <br/> 314 </td> 315 </tr> 316 <tr> 317 <td colspan="1"> 318 <div class="ansibleOptionAnchor" id="return-state"></div> 319 <b>state</b> 320 <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> 321 <div style="font-size: small"> 322 <span style="color: purple">string</span> 323 </div> 324 </td> 325 <td>always</td> 326 <td> 327 <div>Status after module execution.</div> 328 <br/> 329 </td> 330 </tr> 331 </table> 332 <br/><br/> 333 334.. Status (Presently only deprecated) 335 336 337.. Authors 338 339Authors 340~~~~~~~ 341 342- WangBaoshan (@ISIB-group) 343 344 345 346.. Parsing errors 347 348