dellemc.openmanage.ome_user (2.1.5) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module creates, modifies or deletes a user on OpenManage Enterprise.

Requirements

• python >= 2.7.5

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: create user with required parameters.
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    attributes:
      UserName: "user1"
      Password: "UserPassword"
      RoleId: "10"
      Enabled: True

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create user with all parameters.
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    attributes:
      UserName: "user2"
      Description: "user2 description"
      Password: "UserPassword"
      RoleId: "10"
      Enabled: True
      DirectoryServiceId: 0
      UserTypeId: 1
      Locked: False
      Name: "user2"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: modify existing user.
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    attributes:
      UserName: "user3"
      RoleId: "10"
      Enabled: True
      Description: "Modify user Description"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: delete existing user using id.
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "absent"
    user_id: 1234

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: delete existing user using name.
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "absent"
    name: "name"

Inputs

    
name:
    description:
    - Unique Name of the user to be deleted.
    - Either I(user_id) or I(name) is mandatory for C(absent) operation.
    type: str

port:
    default: 443
    description: Target HTTPS port.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - C(present) creates a user in case the I(UserName) provided inside I(attributes)
      does not exist.
    - C(present) modifies a user in case the I(UserName) provided inside I(attributes)
      exists.
    - C(absent) deletes an existing user.
    type: str

user_id:
    description:
    - Unique ID of the user to be deleted.
    - Either I(user_id) or I(name) is mandatory for C(absent) operation.
    type: int

hostname:
    description: Target IP address or hostname.
    required: true
    type: str

password:
    description: Target user password.
    required: true
    type: str

username:
    description: Target username.
    required: true
    type: str

attributes:
    default: {}
    description:
    - Payload data for the user operations. It can take the following attributes for C(present).
    - UserTypeId, DirectoryServiceId, Description, Name, Password, UserName, RoleId, Locked,
      Enabled.
    - OME will throw error if required parameter is not provided for operation.
    - Refer OpenManage Enterprise API Reference Guide for more details.
    type: dict

Outputs

msg:
  description: Overall status of the user operation.
  returned: always
  sample: Successfully created a User
  type: str
user_status:
  description: Details of the user operation, when I(state) is C(present).
  returned: When I(state) is C(present).
  sample:
    Description: Test user creation
    DirectoryServiceId: 0
    Enabled: true
    Id: '61546'
    IsBuiltin: false
    Locked: false
    Name: test
    Password: null
    PlainTextPassword: null
    RoleId: '10'
    UserName: test
    UserTypeId: 1
  type: dict