1.. Document meta 2 3:orphan: 4 5.. Anchors 6 7.. _ansible_collections.inspur.sm.edit_smtp_com_module: 8 9.. Anchors: short name for ansible.builtin 10 11.. Anchors: aliases 12 13 14 15.. Title 16 17inspur.sm.edit_smtp_com -- Set SMTP information. 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_smtp_com`. 28 29.. version_added 30 31.. versionadded:: 1.2.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 SMTP com information on Inspur server. 46- Only the M6 models support this feature. 47 48.. Aliases 49 50 51.. Requirements 52 53 54.. Options 55 56Parameters 57---------- 58 59.. raw:: html 60 61 <table border=0 cellpadding=0 class="documentation-table"> 62 <tr> 63 <th colspan="2">Parameter</th> 64 <th>Choices/<font color="blue">Defaults</font></th> 65 <th width="100%">Comments</th> 66 </tr> 67 <tr> 68 <td colspan="2"> 69 <div class="ansibleOptionAnchor" id="parameter-asset_tag"></div> 70 <b>asset_tag</b> 71 <a class="ansibleOptionLink" href="#parameter-asset_tag" title="Permalink to this option"></a> 72 <div style="font-size: small"> 73 <span style="color: purple">string</span> 74 </div> 75 </td> 76 <td> 77 </td> 78 <td> 79 <div>product asset label,</div> 80 </td> 81 </tr> 82 <tr> 83 <td colspan="2"> 84 <div class="ansibleOptionAnchor" id="parameter-email"></div> 85 <b>email</b> 86 <a class="ansibleOptionLink" href="#parameter-email" 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>Sender email.</div> 95 </td> 96 </tr> 97 <tr> 98 <td colspan="2"> 99 <div class="ansibleOptionAnchor" id="parameter-event_level"></div> 100 <b>event_level</b> 101 <a class="ansibleOptionLink" href="#parameter-event_level" 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 </td> 108 <td> 109 <div>Events above this level will be sent.</div> 110 </td> 111 </tr> 112 <tr> 113 <td colspan="2"> 114 <div class="ansibleOptionAnchor" id="parameter-host"></div> 115 <b>host</b> 116 <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> 117 <div style="font-size: small"> 118 <span style="color: purple">string</span> 119 </div> 120 </td> 121 <td> 122 </td> 123 <td> 124 <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> 125 </td> 126 </tr> 127 <tr> 128 <td colspan="2"> 129 <div class="ansibleOptionAnchor" id="parameter-host_name"></div> 130 <b>host_name</b> 131 <a class="ansibleOptionLink" href="#parameter-host_name" 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>Server name.</div> 140 </td> 141 </tr> 142 <tr> 143 <td colspan="2"> 144 <div class="ansibleOptionAnchor" id="parameter-password"></div> 145 <b>password</b> 146 <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> 147 <div style="font-size: small"> 148 <span style="color: purple">string</span> 149 </div> 150 </td> 151 <td> 152 </td> 153 <td> 154 <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> 155 </td> 156 </tr> 157 <tr> 158 <td colspan="2"> 159 <div class="ansibleOptionAnchor" id="parameter-provider"></div> 160 <b>provider</b> 161 <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> 162 <div style="font-size: small"> 163 <span style="color: purple">dictionary</span> 164 </div> 165 </td> 166 <td> 167 </td> 168 <td> 169 <div>A dict object containing connection details.</div> 170 </td> 171 </tr> 172 <tr> 173 <td class="elbow-placeholder"></td> 174 <td colspan="1"> 175 <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> 176 <b>host</b> 177 <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> 178 <div style="font-size: small"> 179 <span style="color: purple">string</span> 180 </div> 181 </td> 182 <td> 183 </td> 184 <td> 185 <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> 186 </td> 187 </tr> 188 <tr> 189 <td class="elbow-placeholder"></td> 190 <td colspan="1"> 191 <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> 192 <b>password</b> 193 <a class="ansibleOptionLink" href="#parameter-provider/password" 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 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> 202 </td> 203 </tr> 204 <tr> 205 <td class="elbow-placeholder"></td> 206 <td colspan="1"> 207 <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> 208 <b>username</b> 209 <a class="ansibleOptionLink" href="#parameter-provider/username" 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>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> 218 </td> 219 </tr> 220 221 <tr> 222 <td colspan="2"> 223 <div class="ansibleOptionAnchor" id="parameter-serial_number"></div> 224 <b>serial_number</b> 225 <a class="ansibleOptionLink" href="#parameter-serial_number" 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>Serial number.</div> 234 </td> 235 </tr> 236 <tr> 237 <td colspan="2"> 238 <div class="ansibleOptionAnchor" id="parameter-server_auth"></div> 239 <b>server_auth</b> 240 <a class="ansibleOptionLink" href="#parameter-server_auth" title="Permalink to this option"></a> 241 <div style="font-size: small"> 242 <span style="color: purple">string</span> 243 </div> 244 </td> 245 <td> 246 <ul style="margin: 0; padding: 0"><b>Choices:</b> 247 <li>enable</li> 248 <li>disable</li> 249 </ul> 250 </td> 251 <td> 252 <div>SMTP server authentication.</div> 253 </td> 254 </tr> 255 <tr> 256 <td colspan="2"> 257 <div class="ansibleOptionAnchor" id="parameter-server_ip"></div> 258 <b>server_ip</b> 259 <a class="ansibleOptionLink" href="#parameter-server_ip" title="Permalink to this option"></a> 260 <div style="font-size: small"> 261 <span style="color: purple">string</span> 262 </div> 263 </td> 264 <td> 265 </td> 266 <td> 267 <div>SMTP server IP.</div> 268 </td> 269 </tr> 270 <tr> 271 <td colspan="2"> 272 <div class="ansibleOptionAnchor" id="parameter-server_password"></div> 273 <b>server_password</b> 274 <a class="ansibleOptionLink" href="#parameter-server_password" title="Permalink to this option"></a> 275 <div style="font-size: small"> 276 <span style="color: purple">string</span> 277 </div> 278 </td> 279 <td> 280 </td> 281 <td> 282 <div>SMTP server Password,lenth be 4 to 64 bits,cannot contain ' '(space).</div> 283 <div>Required when <em>server_auth=enable</em>.</div> 284 </td> 285 </tr> 286 <tr> 287 <td colspan="2"> 288 <div class="ansibleOptionAnchor" id="parameter-server_port"></div> 289 <b>server_port</b> 290 <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a> 291 <div style="font-size: small"> 292 <span style="color: purple">integer</span> 293 </div> 294 </td> 295 <td> 296 </td> 297 <td> 298 <div>SMTP server port,The Identification for retry count configuration(1-65535).</div> 299 </td> 300 </tr> 301 <tr> 302 <td colspan="2"> 303 <div class="ansibleOptionAnchor" id="parameter-server_secure_port"></div> 304 <b>server_secure_port</b> 305 <a class="ansibleOptionLink" href="#parameter-server_secure_port" title="Permalink to this option"></a> 306 <div style="font-size: small"> 307 <span style="color: purple">integer</span> 308 </div> 309 </td> 310 <td> 311 </td> 312 <td> 313 <div>SMTP server sesure port,The Identification for retry count configuration(1-65535).</div> 314 </td> 315 </tr> 316 <tr> 317 <td colspan="2"> 318 <div class="ansibleOptionAnchor" id="parameter-server_username"></div> 319 <b>server_username</b> 320 <a class="ansibleOptionLink" href="#parameter-server_username" title="Permalink to this option"></a> 321 <div style="font-size: small"> 322 <span style="color: purple">string</span> 323 </div> 324 </td> 325 <td> 326 </td> 327 <td> 328 <div>SMTP server Username,lenth be 4 to 64 bits,</div> 329 <div>must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div> 330 <div>Required when <em>server_auth=enable</em>.</div> 331 </td> 332 </tr> 333 <tr> 334 <td colspan="2"> 335 <div class="ansibleOptionAnchor" id="parameter-ssl_tls_enable"></div> 336 <b>ssl_tls_enable</b> 337 <a class="ansibleOptionLink" href="#parameter-ssl_tls_enable" title="Permalink to this option"></a> 338 <div style="font-size: small"> 339 <span style="color: purple">string</span> 340 </div> 341 </td> 342 <td> 343 <ul style="margin: 0; padding: 0"><b>Choices:</b> 344 <li>enable</li> 345 <li>disable</li> 346 </ul> 347 </td> 348 <td> 349 <div>SMTP SSLTLS Enable.</div> 350 <div><em>ssl_tls_enable=disable</em>, when <em>star_tls_enable=enable</em>.</div> 351 </td> 352 </tr> 353 <tr> 354 <td colspan="2"> 355 <div class="ansibleOptionAnchor" id="parameter-star_tls_enable"></div> 356 <b>star_tls_enable</b> 357 <a class="ansibleOptionLink" href="#parameter-star_tls_enable" title="Permalink to this option"></a> 358 <div style="font-size: small"> 359 <span style="color: purple">string</span> 360 </div> 361 </td> 362 <td> 363 <ul style="margin: 0; padding: 0"><b>Choices:</b> 364 <li>enable</li> 365 <li>disable</li> 366 </ul> 367 </td> 368 <td> 369 <div>SMTP STARTTLS Enable.</div> 370 <div><em>star_tls_enable=disable</em>, when <em>ssl_tls_enable=enable</em>.</div> 371 </td> 372 </tr> 373 <tr> 374 <td colspan="2"> 375 <div class="ansibleOptionAnchor" id="parameter-status"></div> 376 <b>status</b> 377 <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a> 378 <div style="font-size: small"> 379 <span style="color: purple">string</span> 380 / <span style="color: red">required</span> </div> 381 </td> 382 <td> 383 <ul style="margin: 0; padding: 0"><b>Choices:</b> 384 <li>enable</li> 385 <li>disable</li> 386 </ul> 387 </td> 388 <td> 389 <div>SMTP Support.</div> 390 </td> 391 </tr> 392 <tr> 393 <td colspan="2"> 394 <div class="ansibleOptionAnchor" id="parameter-subject"></div> 395 <b>subject</b> 396 <a class="ansibleOptionLink" href="#parameter-subject" title="Permalink to this option"></a> 397 <div style="font-size: small"> 398 <span style="color: purple">string</span> 399 </div> 400 </td> 401 <td> 402 </td> 403 <td> 404 <div>Email theme.</div> 405 </td> 406 </tr> 407 <tr> 408 <td colspan="2"> 409 <div class="ansibleOptionAnchor" id="parameter-username"></div> 410 <b>username</b> 411 <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> 412 <div style="font-size: small"> 413 <span style="color: purple">string</span> 414 </div> 415 </td> 416 <td> 417 </td> 418 <td> 419 <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> 420 </td> 421 </tr> 422 </table> 423 <br/> 424 425.. Notes 426 427 428.. Seealso 429 430 431.. Examples 432 433Examples 434-------- 435 436.. code-block:: yaml+jinja 437 438 439 - name: Smtp com test 440 hosts: ism 441 no_log: true 442 connection: local 443 gather_facts: no 444 vars: 445 ism: 446 host: "{{ ansible_ssh_host }}" 447 username: "{{ username }}" 448 password: "{{ password }}" 449 450 tasks: 451 452 - name: "Set smtp com information" 453 inspur.sm.edit_smtp_com: 454 status: "disable" 455 provider: "{{ ism }}" 456 457 - name: "Set smtp com information" 458 inspur.sm.edit_smtp_com: 459 status: "enable" 460 server_ip: "100.2.2.2" 461 email: "inspur@Inspur.com" 462 server_auth: "enable" 463 server_username: "admin" 464 server_password: "1234qwer!@#$" 465 provider: "{{ ism }}" 466 467 468 469 470.. Facts 471 472 473.. Return values 474 475Return Values 476------------- 477Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: 478 479.. raw:: html 480 481 <table border=0 cellpadding=0 class="documentation-table"> 482 <tr> 483 <th colspan="1">Key</th> 484 <th>Returned</th> 485 <th width="100%">Description</th> 486 </tr> 487 <tr> 488 <td colspan="1"> 489 <div class="ansibleOptionAnchor" id="return-changed"></div> 490 <b>changed</b> 491 <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> 492 <div style="font-size: small"> 493 <span style="color: purple">boolean</span> 494 </div> 495 </td> 496 <td>always</td> 497 <td> 498 <div>Check to see if a change was made on the device.</div> 499 <br/> 500 </td> 501 </tr> 502 <tr> 503 <td colspan="1"> 504 <div class="ansibleOptionAnchor" id="return-message"></div> 505 <b>message</b> 506 <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> 507 <div style="font-size: small"> 508 <span style="color: purple">string</span> 509 </div> 510 </td> 511 <td>always</td> 512 <td> 513 <div>Messages returned after module execution.</div> 514 <br/> 515 </td> 516 </tr> 517 <tr> 518 <td colspan="1"> 519 <div class="ansibleOptionAnchor" id="return-state"></div> 520 <b>state</b> 521 <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> 522 <div style="font-size: small"> 523 <span style="color: purple">string</span> 524 </div> 525 </td> 526 <td>always</td> 527 <td> 528 <div>Status after module execution.</div> 529 <br/> 530 </td> 531 </tr> 532 </table> 533 <br/><br/> 534 535.. Status (Presently only deprecated) 536 537 538.. Authors 539 540Authors 541~~~~~~~ 542 543- WangBaoshan (@ISIB-group) 544 545 546 547.. Parsing errors 548 549