latest--role-arg-spec

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/ansible-meta/_shared/latest--role-arg-spec.json
Parent schema ansible-meta
Type: object

See role-argument-validation

Properties

argument_specs Record<string, object>

Add entry point, usually main. See role-argument-validation

Definitions

attribute object
description string | string[] required

Detailed explanation of what this attribute does. It should be written in full sentences.

support string required
Values: "full" "partial" "none" "N/A"
details string | string[]

Detailed explanation of what this attribute does. It should be written in full sentences.

membership string | string[]
platform string | string[]
version_added string
datatype string
deprecated_alias object
name string required
collection_name string
date string
version string
entry_point object
attributes Record<string, object>
author string | string[]
description string | string[]
examples string
options Record<string, object>
seealso object | object | object | object[]
short_description string
version_added string
full-jinja string
option object

See argument-spec

apply_defaults string
choices array | string
default
Default: "None"
description string | string[]

Detailed explanation of what this option does. It should be written in full sentences.

elements string
Values: "str" "list" "dict" "bool" "int" "float" "path" "raw" "jsonarg" "json" "bytes" "bits"
fallback string
Default: "None"
no_log boolean
Default: false
option-name string

The name of the option/argument.

options Record<string, object>
required boolean
Default: false
mutually_exclusive array
required_together string[][]
required_one_of array
required_if array[]
required_by Record<string, string | string[]>
type string
Values: "str" "list" "dict" "bool" "int" "float" "path" "raw" "jsonarg" "json" "bytes" "bits"
version_added string

Examples

"meta/argument_specs.yml"