1.. Document meta 2 3:orphan: 4 5.. Anchors 6 7.. _ansible_collections.inspur.sm.del_ad_group_module: 8 9.. Anchors: short name for ansible.builtin 10 11.. Anchors: aliases 12 13 14 15.. Title 16 17inspur.sm.del_ad_group -- Delete active directory group 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.del_ad_group`. 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 39DEPRECATED 40---------- 41:Removed in: version 3.0.0 42:Why: Merge functions into the :ref:`inspur.sm.ad_group <ansible_collections.inspur.sm.ad_group_module>` module. 43:Alternative: Use :ref:`inspur.sm.ad_group <ansible_collections.inspur.sm.ad_group_module>` instead. 44 45Synopsis 46-------- 47 48.. Description 49 50- Delete active directory group information on Inspur server. 51 52.. Aliases 53 54 55.. Requirements 56 57 58.. Options 59 60Parameters 61---------- 62 63.. raw:: html 64 65 <table border=0 cellpadding=0 class="documentation-table"> 66 <tr> 67 <th colspan="2">Parameter</th> 68 <th>Choices/<font color="blue">Defaults</font></th> 69 <th width="100%">Comments</th> 70 </tr> 71 <tr> 72 <td colspan="2"> 73 <div class="ansibleOptionAnchor" id="parameter-host"></div> 74 <b>host</b> 75 <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> 76 <div style="font-size: small"> 77 <span style="color: purple">string</span> 78 </div> 79 </td> 80 <td> 81 </td> 82 <td> 83 <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> 84 </td> 85 </tr> 86 <tr> 87 <td colspan="2"> 88 <div class="ansibleOptionAnchor" id="parameter-name"></div> 89 <b>name</b> 90 <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> 91 <div style="font-size: small"> 92 <span style="color: purple">string</span> 93 / <span style="color: red">required</span> </div> 94 </td> 95 <td> 96 </td> 97 <td> 98 <div>Group name.</div> 99 </td> 100 </tr> 101 <tr> 102 <td colspan="2"> 103 <div class="ansibleOptionAnchor" id="parameter-password"></div> 104 <b>password</b> 105 <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> 106 <div style="font-size: small"> 107 <span style="color: purple">string</span> 108 </div> 109 </td> 110 <td> 111 </td> 112 <td> 113 <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> 114 </td> 115 </tr> 116 <tr> 117 <td colspan="2"> 118 <div class="ansibleOptionAnchor" id="parameter-provider"></div> 119 <b>provider</b> 120 <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> 121 <div style="font-size: small"> 122 <span style="color: purple">dictionary</span> 123 </div> 124 </td> 125 <td> 126 </td> 127 <td> 128 <div>A dict object containing connection details.</div> 129 </td> 130 </tr> 131 <tr> 132 <td class="elbow-placeholder"></td> 133 <td colspan="1"> 134 <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> 135 <b>host</b> 136 <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> 137 <div style="font-size: small"> 138 <span style="color: purple">string</span> 139 </div> 140 </td> 141 <td> 142 </td> 143 <td> 144 <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> 145 </td> 146 </tr> 147 <tr> 148 <td class="elbow-placeholder"></td> 149 <td colspan="1"> 150 <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> 151 <b>password</b> 152 <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> 153 <div style="font-size: small"> 154 <span style="color: purple">string</span> 155 </div> 156 </td> 157 <td> 158 </td> 159 <td> 160 <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> 161 </td> 162 </tr> 163 <tr> 164 <td class="elbow-placeholder"></td> 165 <td colspan="1"> 166 <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> 167 <b>username</b> 168 <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> 169 <div style="font-size: small"> 170 <span style="color: purple">string</span> 171 </div> 172 </td> 173 <td> 174 </td> 175 <td> 176 <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> 177 </td> 178 </tr> 179 180 <tr> 181 <td colspan="2"> 182 <div class="ansibleOptionAnchor" id="parameter-username"></div> 183 <b>username</b> 184 <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> 185 <div style="font-size: small"> 186 <span style="color: purple">string</span> 187 </div> 188 </td> 189 <td> 190 </td> 191 <td> 192 <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> 193 </td> 194 </tr> 195 </table> 196 <br/> 197 198.. Notes 199 200 201.. Seealso 202 203 204.. Examples 205 206Examples 207-------- 208 209.. code-block:: yaml+jinja 210 211 212 - name: Ad group test 213 hosts: ism 214 connection: local 215 gather_facts: no 216 vars: 217 ism: 218 host: "{{ ansible_ssh_host }}" 219 username: "{{ username }}" 220 password: "{{ password }}" 221 222 tasks: 223 224 - name: "Delete active directory group information" 225 inspur.sm.del_ad_group: 226 name: "inspur" 227 provider: "{{ ism }}" 228 229 230 231 232.. Facts 233 234 235.. Return values 236 237Return Values 238------------- 239Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: 240 241.. raw:: html 242 243 <table border=0 cellpadding=0 class="documentation-table"> 244 <tr> 245 <th colspan="1">Key</th> 246 <th>Returned</th> 247 <th width="100%">Description</th> 248 </tr> 249 <tr> 250 <td colspan="1"> 251 <div class="ansibleOptionAnchor" id="return-changed"></div> 252 <b>changed</b> 253 <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> 254 <div style="font-size: small"> 255 <span style="color: purple">boolean</span> 256 </div> 257 </td> 258 <td>always</td> 259 <td> 260 <div>Check to see if a change was made on the device.</div> 261 <br/> 262 </td> 263 </tr> 264 <tr> 265 <td colspan="1"> 266 <div class="ansibleOptionAnchor" id="return-message"></div> 267 <b>message</b> 268 <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> 269 <div style="font-size: small"> 270 <span style="color: purple">string</span> 271 </div> 272 </td> 273 <td>always</td> 274 <td> 275 <div>Messages returned after module execution.</div> 276 <br/> 277 </td> 278 </tr> 279 <tr> 280 <td colspan="1"> 281 <div class="ansibleOptionAnchor" id="return-state"></div> 282 <b>state</b> 283 <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> 284 <div style="font-size: small"> 285 <span style="color: purple">string</span> 286 </div> 287 </td> 288 <td>always</td> 289 <td> 290 <div>Status after module execution.</div> 291 <br/> 292 </td> 293 </tr> 294 </table> 295 <br/><br/> 296 297.. Status (Presently only deprecated) 298 299Status 300------ 301 302.. Deprecated note 303 304- This module will be removed in version 3.0.0. 305 *[deprecated]* 306- For more information see `DEPRECATED`_. 307 308 309.. Authors 310 311Authors 312~~~~~~~ 313 314- WangBaoshan (@ISIB-group) 315 316 317 318.. Parsing errors 319 320