cisco.cml.cml_users (1.2.0) — module

Install collection

Install with ansible-galaxy collection install cisco.cml:==1.2.0

Add to requirements.yml

  collections:
    - name: cisco.cml
      version: 1.2.0

Description

Manage CML Users

Requirements

• virl2_client

Usage examples

Scanned by Steampunk Spotter

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

- name: Manage users
  hosts: localhost
  connection: local
  gather_facts: no
  tasks:
    - name: Add users to the CML instance
      cisco.cml.cml_users:
        host: "{{ cml_host }}"
        user: "{{ cml_username }}"
        password: "{{ cml_password }}"
        name: "first_user"
        user_pass: "password"
        admin: yes
        state: "present"

    - name: Remove users from the CML instance
      cisco.cml.cml_users:
        host: "{{ cml_host }}"
        user: "{{ cml_username }}"
        password: "{{ cml_password }}"
        name: "old_user"
        state: "absent"

Inputs

    
host:
    description: FQDN of the target host (CML_HOST)
    required: true
    type: str

name:
    description:
    - Name of the user to create, remove or modify.
    required: true
    type: str

admin:
    default: false
    description:
    - Whether to create admin user.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Whether the account should exist or not, taking action if the state is different
      from what is stated.
    type: str

groups:
    default: []
    description:
    - List of groups user will be added to.
    elements: str
    type: list

timeout:
    default: 30
    description: API Timeout
    required: false
    type: int

fullname:
    default: ''
    description:
    - Full Name of the user to create, remove or modify.
    type: str

password:
    description: user pass for the target system (CML_PASSWORD)
    required: true
    type: str

username:
    aliases:
    - user
    description: user credential for target system (CML_USERNAME)
    required: true
    type: str

user_pass:
    description:
    - Desired password.
    type: str

description:
    default: ''
    description:
    - Optionally sets the description of user account.
    type: str

validate_certs:
    default: false
    description: certificate validation (CML_VALIDATE_CERTS)
    required: false
    type: bool