inspur.sm.edit_ldap_group module – Set ldap group information.

Note

This module is part of the inspur.sm collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install inspur.sm.

To use it in a playbook, specify: inspur.sm.edit_ldap_group.

New in inspur.sm 0.1.0

DEPRECATED

Removed in:

version 3.0.0

Why:

Merge functions into the inspur.sm.ldap_group module.

Alternative:

Use inspur.sm.ldap_group instead.

Synopsis

  • Set ldap group information on Inspur server.

Parameters

Parameter

Comments

base

string

Search Base

Search base is a string of 4 to 64 alpha-numeric characters;

It must start with an alphabetical character;

Special Symbols like dot(.), comma(,), hyphen(-), underscore(_), equal-to(=) are allowed.

host

string

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.

id

string / required

Group id.

Choices:

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

kvm

string

Kvm privilege.

Choices:

  • "enable"

  • "disable"

name

string

Group name.

password

string

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 ANSIBLE_NET_PASSWORD will be used instead.

pri

string

Group privilege.

Choices:

  • "administrator"

  • "user"

  • "operator"

  • "oem"

  • "none"

provider

dictionary

A dict object containing connection details.

host

string

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.

password

string

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 ANSIBLE_NET_PASSWORD will be used instead.

username

string

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 ANSIBLE_NET_USERNAME will be used instead.

username

string

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 ANSIBLE_NET_USERNAME will be used instead.

vm

string

Vmedia privilege.

Choices:

  • "enable"

  • "disable"

Examples

- name: Ldap group test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Edit ldap group information"
    inspur.sm.edit_ldap_group:
      id: "1"
      name: "wbs"
      base: "cn=manager"
      pri: "administrator"
      kvm: "enable"
      vm: "disable"
      provider: "{{ ism }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Status

  • This module will be removed in version 3.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • WangBaoshan (@ISIB-group)