mrichardson03.test_collection.test_module (3.1.6) — module

Install collection

Install with ansible-galaxy collection install mrichardson03.test_collection:==3.1.6

Add to requirements.yml

  collections:
    - name: mrichardson03.test_collection
      version: 3.1.6

Description

This is a longer description of a test module

Usage examples

Scanned by Steampunk Spotter

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

# Pass in a message
- name: Test with a message
  test_module:
    name: hello world

Scanned by Steampunk Spotter

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

- name: Test with a message and changed output
  test_module:
    name: hello world
    new: true

Scanned by Steampunk Spotter

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

- name: Fail the module
  test_module:
    name: fail me

Inputs

    
new:
    default: false
    description:
    - Control to demo if the result of this module is changed
    required: false
    type: bool

name:
    description:
    - This is the message to send to the test module
    required: true
    type: str

shiny:
    default: false
    description:
    - Shiny new option to test the documentation.
    required: false
    type: bool

Outputs

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