cisco.catalystcenter.user module -- Resource module for User

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.user.

New in cisco.catalystcenter 1.0.0

Synopsis

  • Manage operations create, update and delete of the resource User. - > Add a new user in the system.This API provides the ability create a user in the system. A user represents a human that desires to access and manage resources provided by the system. It is recommended to use 'accessGroups' list of access group ids in the input instead of role's name in roleList from the current release onwards.

  • Delete a user in the system. - > Update a user in the system. It is recommended to use 'accessGroups' list of access group ids in the input instead of role's name in roleList from the current release onwards. Please refer to the add user API POST /dna/system/api/v1/user for more details about users.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

accessGroups

list / elements=string

List of access groups that will be assigned to the user. The first access group in the list will be the default access group activated when the user authenticates.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

email

string

The email address of the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

password

string

The password of the user.

roleList

list / elements=string

Role id list.

userId

string

UserId path parameter. The id of the user to be deleted.

username

string

The username of the user.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are user_and_roles.UserAndRoles.add_user, user_and_roles.UserAndRoles.delete_user_api, user_and_roles.UserAndRoles.update_user,

  • Paths used are post /dna/system/api/v1/user, delete /dna/system/api/v1/user/{userId}, put /dna/system/api/v1/user,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for User and Roles AddUser

Complete reference of the AddUser API.

Cisco Catalyst Center documentation for User and Roles DeleteUserAPI

Complete reference of the DeleteUserAPI API.

Cisco Catalyst Center documentation for User and Roles UpdateUser

Complete reference of the UpdateUser API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.user:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    userId: string
- name: Create
  cisco.catalystcenter.user:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    accessGroups:
      - string
    email: string
    firstName: string
    lastName: string
    password: string
    roleList:
      - string
    username: string
- name: Update all
  cisco.catalystcenter.user:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    accessGroups:
      - string
    email: string
    firstName: string
    lastName: string
    roleList:
      - string
    userId: string

Return Values

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

Key

Description

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"message": "string"}`

Authors

  • Bryan Vargas (@bvargasre)