newswangerd.c1.my_sample_module (1.0.1) — module

This is my sample module

| "added in version" 2.4 of newswangerd.c1"

Authors: Your Name (@yourhandle)

preview | supported by community

Install collection

Install with ansible-galaxy collection install newswangerd.c1:==1.0.1


Add to requirements.yml

  collections:
    - name: newswangerd.c1
      version: 1.0.1

Description

This is my longer description explaining my sample module

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Pass in a message
- name: Test with a message
  my_sample_module:
    name: hello world
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# pass in a message and have changed true
- name: Test with a message and changed output
  my_sample_module:
    name: hello world
    new: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# fail the module
- name: Test failure of the module
  my_sample_module:
    name: fail me

Inputs

    
new:
    description:
    - Control to demo if the result of this module is changed or not
    required: false

name:
    description:
    - This is the message to send to the sample module
    required: true

Outputs

message:
  description: The output message that the sample module generates
original_message:
  description: The original name param that was passed in
  type: str