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