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