cisco.cml.cml_node (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

Create, update or delete a node in a CML Lab

Requirements

• virl2_client

Usage examples

Scanned by Steampunk Spotter

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

- name: Start the CML nodes
  hosts: cml_hosts
  connection: local
  gather_facts: no
  tasks:
    - name: Generating day0 config
      set_fact:
        day0_config: "{{ lookup('template', cml_config_template) }}"
      when: cml_config_template is defined

    - name: Start Node
      cisco.cml.cml_node:
        name: "{{ inventory_hostname }}"
        host: "{{ cml_host }}"
        user: "{{ cml_username }}"
        password: "{{ cml_password }}"
        lab: "{{ cml_lab }}"
        state: started
        image_definition: "{{ cml_image_definition | default(omit) }}"
        config: "{{ day0_config | default(omit) }}"

Inputs

    
x:
    description: X coordinate on topology canvas
    required: false
    type: int

y:
    description: Y coordinate on topology canvas
    required: false
    type: int

lab:
    description: The name of the CML lab (CML_LAB)
    required: true
    type: str

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

name:
    description: The name of the node
    required: true
    type: str

tags:
    description: List of tags
    elements: str
    required: false
    type: list

wait:
    default: false
    description: Wait for lab virtual machines to boot before continuing
    required: false
    type: bool

state:
    choices:
    - absent
    - present
    - started
    - stopped
    - wiped
    default: present
    description: The desired state of the node
    required: false
    type: str

config:
    description: The day0 configuration of this node
    required: false
    type: str

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

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

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

node_definition:
    description: The node definition of this node
    required: false
    type: str

image_definition:
    description: The image definition of this node
    required: false
    type: str