1.. Document meta 2 3:orphan: 4 5.. Anchors 6 7.. _ansible_collections.inspur.sm.add_ldap_group_module: 8 9.. Anchors: short name for ansible.builtin 10 11.. Anchors: aliases 12 13 14 15.. Title 16 17inspur.sm.add_ldap_group -- Add ldap 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.add_ldap_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.ldap_group <ansible_collections.inspur.sm.ldap_group_module>` module. 43:Alternative: Use :ref:`inspur.sm.ldap_group <ansible_collections.inspur.sm.ldap_group_module>` instead. 44 45Synopsis 46-------- 47 48.. Description 49 50- Add ldap 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-base"></div> 74 <b>base</b> 75 <a class="ansibleOptionLink" href="#parameter-base" title="Permalink to this option"></a> 76 <div style="font-size: small"> 77 <span style="color: purple">string</span> 78 / <span style="color: red">required</span> </div> 79 </td> 80 <td> 81 </td> 82 <td> 83 <div>Search Base.</div> 84 </td> 85 </tr> 86 <tr> 87 <td colspan="2"> 88 <div class="ansibleOptionAnchor" id="parameter-host"></div> 89 <b>host</b> 90 <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> 91 <div style="font-size: small"> 92 <span style="color: purple">string</span> 93 </div> 94 </td> 95 <td> 96 </td> 97 <td> 98 <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> 99 </td> 100 </tr> 101 <tr> 102 <td colspan="2"> 103 <div class="ansibleOptionAnchor" id="parameter-kvm"></div> 104 <b>kvm</b> 105 <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a> 106 <div style="font-size: small"> 107 <span style="color: purple">string</span> 108 / <span style="color: red">required</span> </div> 109 </td> 110 <td> 111 <ul style="margin: 0; padding: 0"><b>Choices:</b> 112 <li>enable</li> 113 <li>disable</li> 114 </ul> 115 </td> 116 <td> 117 <div>Kvm privilege.</div> 118 </td> 119 </tr> 120 <tr> 121 <td colspan="2"> 122 <div class="ansibleOptionAnchor" id="parameter-name"></div> 123 <b>name</b> 124 <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> 125 <div style="font-size: small"> 126 <span style="color: purple">string</span> 127 / <span style="color: red">required</span> </div> 128 </td> 129 <td> 130 </td> 131 <td> 132 <div>Group name.</div> 133 </td> 134 </tr> 135 <tr> 136 <td colspan="2"> 137 <div class="ansibleOptionAnchor" id="parameter-password"></div> 138 <b>password</b> 139 <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> 140 <div style="font-size: small"> 141 <span style="color: purple">string</span> 142 </div> 143 </td> 144 <td> 145 </td> 146 <td> 147 <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> 148 </td> 149 </tr> 150 <tr> 151 <td colspan="2"> 152 <div class="ansibleOptionAnchor" id="parameter-pri"></div> 153 <b>pri</b> 154 <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a> 155 <div style="font-size: small"> 156 <span style="color: purple">string</span> 157 / <span style="color: red">required</span> </div> 158 </td> 159 <td> 160 <ul style="margin: 0; padding: 0"><b>Choices:</b> 161 <li>administrator</li> 162 <li>user</li> 163 <li>operator</li> 164 <li>oem</li> 165 <li>none</li> 166 </ul> 167 </td> 168 <td> 169 <div>Group privilege.</div> 170 </td> 171 </tr> 172 <tr> 173 <td colspan="2"> 174 <div class="ansibleOptionAnchor" id="parameter-provider"></div> 175 <b>provider</b> 176 <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> 177 <div style="font-size: small"> 178 <span style="color: purple">dictionary</span> 179 </div> 180 </td> 181 <td> 182 </td> 183 <td> 184 <div>A dict object containing connection details.</div> 185 </td> 186 </tr> 187 <tr> 188 <td class="elbow-placeholder"></td> 189 <td colspan="1"> 190 <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> 191 <b>host</b> 192 <a class="ansibleOptionLink" href="#parameter-provider/host" 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>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> 201 </td> 202 </tr> 203 <tr> 204 <td class="elbow-placeholder"></td> 205 <td colspan="1"> 206 <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> 207 <b>password</b> 208 <a class="ansibleOptionLink" href="#parameter-provider/password" 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>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> 217 </td> 218 </tr> 219 <tr> 220 <td class="elbow-placeholder"></td> 221 <td colspan="1"> 222 <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> 223 <b>username</b> 224 <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> 225 <div style="font-size: small"> 226 <span style="color: purple">string</span> 227 </div> 228 </td> 229 <td> 230 </td> 231 <td> 232 <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> 233 </td> 234 </tr> 235 236 <tr> 237 <td colspan="2"> 238 <div class="ansibleOptionAnchor" id="parameter-username"></div> 239 <b>username</b> 240 <a class="ansibleOptionLink" href="#parameter-username" 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 </td> 247 <td> 248 <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> 249 </td> 250 </tr> 251 <tr> 252 <td colspan="2"> 253 <div class="ansibleOptionAnchor" id="parameter-vm"></div> 254 <b>vm</b> 255 <a class="ansibleOptionLink" href="#parameter-vm" title="Permalink to this option"></a> 256 <div style="font-size: small"> 257 <span style="color: purple">string</span> 258 / <span style="color: red">required</span> </div> 259 </td> 260 <td> 261 <ul style="margin: 0; padding: 0"><b>Choices:</b> 262 <li>enable</li> 263 <li>disable</li> 264 </ul> 265 </td> 266 <td> 267 <div>Vmedia privilege.</div> 268 </td> 269 </tr> 270 </table> 271 <br/> 272 273.. Notes 274 275 276.. Seealso 277 278 279.. Examples 280 281Examples 282-------- 283 284.. code-block:: yaml+jinja 285 286 287 - name: Ldap group test 288 hosts: ism 289 connection: local 290 gather_facts: no 291 vars: 292 ism: 293 host: "{{ ansible_ssh_host }}" 294 username: "{{ username }}" 295 password: "{{ password }}" 296 297 tasks: 298 299 - name: "Add ldap group information" 300 inspur.sm.add_ldap_group: 301 name: "wbs" 302 base: "cn=manager" 303 pri: "administrator" 304 kvm: "enable" 305 vm: "disable" 306 provider: "{{ ism }}" 307 308 309 310 311.. Facts 312 313 314.. Return values 315 316Return Values 317------------- 318Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: 319 320.. raw:: html 321 322 <table border=0 cellpadding=0 class="documentation-table"> 323 <tr> 324 <th colspan="1">Key</th> 325 <th>Returned</th> 326 <th width="100%">Description</th> 327 </tr> 328 <tr> 329 <td colspan="1"> 330 <div class="ansibleOptionAnchor" id="return-changed"></div> 331 <b>changed</b> 332 <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> 333 <div style="font-size: small"> 334 <span style="color: purple">boolean</span> 335 </div> 336 </td> 337 <td>always</td> 338 <td> 339 <div>Check to see if a change was made on the device.</div> 340 <br/> 341 </td> 342 </tr> 343 <tr> 344 <td colspan="1"> 345 <div class="ansibleOptionAnchor" id="return-message"></div> 346 <b>message</b> 347 <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> 348 <div style="font-size: small"> 349 <span style="color: purple">string</span> 350 </div> 351 </td> 352 <td>always</td> 353 <td> 354 <div>Messages returned after module execution.</div> 355 <br/> 356 </td> 357 </tr> 358 <tr> 359 <td colspan="1"> 360 <div class="ansibleOptionAnchor" id="return-state"></div> 361 <b>state</b> 362 <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> 363 <div style="font-size: small"> 364 <span style="color: purple">string</span> 365 </div> 366 </td> 367 <td>always</td> 368 <td> 369 <div>Status after module execution.</div> 370 <br/> 371 </td> 372 </tr> 373 </table> 374 <br/><br/> 375 376.. Status (Presently only deprecated) 377 378Status 379------ 380 381.. Deprecated note 382 383- This module will be removed in version 3.0.0. 384 *[deprecated]* 385- For more information see `DEPRECATED`_. 386 387 388.. Authors 389 390Authors 391~~~~~~~ 392 393- WangBaoshan (@ISIB-group) 394 395 396 397.. Parsing errors 398 399