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