template role -- Basic template for Linux system roles
Entry point main -- Basic template for Linux system roles
Synopsis
One or more sentences describing what the role does.
Parameters
Parameter |
Comments |
|---|---|
A boolean variable that enables or disables the bar feature. Choices:
|
|
An integer variable for a numeric setting. Default: |
|
Filesystem path to the configuration file, for example Default: |
|
A string variable for the foo setting. Default: |
|
A list of package names. Use elements to declare the type of each item in the list. Default: |
|
A variable that accepts values of different types. Use raw when the variable can be either a string or a list, for example. Default: |
|
A list of service configurations. Each entry is a dictionary with its own set of options. Use this pattern when the role takes a list of structured items. Default: |
|
Whether the service should be enabled at boot. Choices:
|
|
Name of the service. Mark a sub-option as required when it must always be provided. |
|
Type of the service. Choices work inside nested options the same way as at the top level. Choices:
|
|
Desired state of the template subsystem. Use choices to restrict a string variable to a fixed set of allowed values, such as Choices:
|
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full |
Whether the role can run in check mode. |
|
Support: full |
Whether a second run with the same arguments reports no change. |
|
Support: full
|
Target operating systems. |
Notes
Note
A technical detail that does not belong in any single option's description.
Examples
- name: Describe what this example play does
hosts: all
vars:
template_foo: custom-value
template_state: enabled
roles:
- linux-system-roles.template
Return Variables
The following variables are set by this role:
Key |
Description |
|---|---|
What this variable holds and when the role sets it. Returned: always Sample: |