Ansible Meta

Ansible meta/main.yml file

Type object | null
File match **/meta/main.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ansible-meta/latest.json
Source https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/meta.json

Validate with Lintel

npx @lintel/lintel check
Type: object | null

https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_reuse_roles.html#using-role-dependencies

Properties

additionalProperties
allow_duplicates boolean
collections string[]
dependencies string | DependencyModel[]
galaxy_info object
All of: variant, variant
15 nested properties
author string
cloud_platforms

Only valid for old standalone roles.

company string
description string
galaxy_tags string[]

See https://galaxy.ansible.com/docs/contributing/creating_role.html

github_branch string

Optionally specify the branch Galaxy will use when accessing the GitHub repo for this role

issue_tracker_url string
license string
min_ansible_container_version string
min_ansible_version string
namespace string

Used by molecule and ansible-lint to compute FQRN for roles outside collections

minLength=2pattern=^[a-z][a-z0-9_-]+$
platforms AIXPlatformModel | AlmaLinuxPlatformModel | AlpinePlatformModel | AmazonPlatformModel | AmazonLinuxPlatformModel | aosPlatformModel | ArchLinuxPlatformModel | AstraLinuxPlatformModel | ClearLinuxPlatformModel | CumulusPlatformModel | NetBSDPlatformModel | DebianPlatformModel | DellOSPlatformModel | DevuanPlatformModel | DragonFlyBSDPlatformModel | ELPlatformModel | eosPlatformModel | FedoraPlatformModel | FreeBSDPlatformModel | GenericBSDPlatformModel | GenericLinuxPlatformModel | GenericUNIXPlatformModel | GentooPlatformModel | HardenedBSDPlatformModel | IOSPlatformModel | JunosPlatformModel | KaliPlatformModel | macOSPlatformModel | MacOSXPlatformModel | MageiaPlatformModel | NXOSPlatformModel | OpenBSDPlatformModel | opensusePlatformModel | OpenWrtPlatformModel | OracleLinuxPlatformModel | os10PlatformModel | PAN-OSPlatformModel | RockyLinuxPlatformModel | SLESPlatformModel | SmartOSPlatformModel | SolarisPlatformModel | SynologyPlatformModel | TMOSPlatformModel | UbuntuPlatformModel | vCenterPlatformModel | Void_LinuxPlatformModel | vSpherePlatformModel | WindowsPlatformModel[]
role_name string
minLength=2pattern=^[a-z][a-z0-9_]+$
standalone boolean

Set to true for old standalone roles, or false for new collection roles.

video_links array

Only valid for old standalone roles.

argument_specs Record<string, entry_point>

Definitions

AIXPlatformModel object
name string
Constant: "AIX"
versions string[]
Default: "all"
AlmaLinuxPlatformModel object
name string
Constant: "AlmaLinux"
versions string[]
Default: "all"
AlpinePlatformModel object
name string
Constant: "Alpine"
versions string[]
Default: "all"
AmazonLinuxPlatformModel object
name string
Constant: "Amazon Linux"
versions string[]
Default: "all"
AmazonPlatformModel object
name string
Constant: "Amazon"
versions string[]
Default: "all"
ArchLinuxPlatformModel object
name string
Constant: "ArchLinux"
versions string[]
Default: "all"
AstraLinuxPlatformModel object
name string
Constant: "Astra Linux"
versions string[]
Default: "all"
ClearLinuxPlatformModel object
name string
Constant: "ClearLinux"
versions string[]
Default: "all"
CumulusPlatformModel object
name string
Constant: "Cumulus"
versions string[]
Default: "all"
DebianPlatformModel object
name string
Constant: "Debian"
versions string[]
Default: "all"
DellOSPlatformModel object
name string
Constant: "DellOS"
versions string[]
Default: "all"
DependencyModel object

See https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_reuse_roles.html#role-dependencies and https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/role/metadata.py#L79

Other keys are treated as role parameters.

become boolean
name string
role string
scm string
Values: "hg" "git"
src string
tags array | string
vars object
version string
when boolean | string | string[]
DevuanPlatformModel object
name string
Constant: "Devuan"
versions string[]
Default: "all"
DragonFlyBSDPlatformModel object
name string
Constant: "DragonFlyBSD"
versions string[]
Default: "all"
ELPlatformModel object
name string
Constant: "EL"
versions string[]
Default: "all"
FedoraPlatformModel object
name string
Constant: "Fedora"
versions string[]
Default: "all"
FreeBSDPlatformModel object
name string
Constant: "FreeBSD"
versions string[]
Default: "all"
GalaxyInfoModel object
author string
cloud_platforms

Only valid for old standalone roles.

company string
description string
galaxy_tags string[]

See https://galaxy.ansible.com/docs/contributing/creating_role.html

github_branch string

Optionally specify the branch Galaxy will use when accessing the GitHub repo for this role

issue_tracker_url string
license string
min_ansible_container_version string
min_ansible_version string
namespace string

Used by molecule and ansible-lint to compute FQRN for roles outside collections

minLength=2pattern=^[a-z][a-z0-9_-]+$
platforms AIXPlatformModel | AlmaLinuxPlatformModel | AlpinePlatformModel | AmazonPlatformModel | AmazonLinuxPlatformModel | aosPlatformModel | ArchLinuxPlatformModel | AstraLinuxPlatformModel | ClearLinuxPlatformModel | CumulusPlatformModel | NetBSDPlatformModel | DebianPlatformModel | DellOSPlatformModel | DevuanPlatformModel | DragonFlyBSDPlatformModel | ELPlatformModel | eosPlatformModel | FedoraPlatformModel | FreeBSDPlatformModel | GenericBSDPlatformModel | GenericLinuxPlatformModel | GenericUNIXPlatformModel | GentooPlatformModel | HardenedBSDPlatformModel | IOSPlatformModel | JunosPlatformModel | KaliPlatformModel | macOSPlatformModel | MacOSXPlatformModel | MageiaPlatformModel | NXOSPlatformModel | OpenBSDPlatformModel | opensusePlatformModel | OpenWrtPlatformModel | OracleLinuxPlatformModel | os10PlatformModel | PAN-OSPlatformModel | RockyLinuxPlatformModel | SLESPlatformModel | SmartOSPlatformModel | SolarisPlatformModel | SynologyPlatformModel | TMOSPlatformModel | UbuntuPlatformModel | vCenterPlatformModel | Void_LinuxPlatformModel | vSpherePlatformModel | WindowsPlatformModel[]
role_name string
minLength=2pattern=^[a-z][a-z0-9_]+$
standalone boolean

Set to true for old standalone roles, or false for new collection roles.

video_links array

Only valid for old standalone roles.

GenericBSDPlatformModel object
name string
Constant: "GenericBSD"
versions string[]
Default: "all"
GenericLinuxPlatformModel object
name string
Constant: "GenericLinux"
versions string[]
Default: "all"
GenericUNIXPlatformModel object
name string
Constant: "GenericUNIX"
versions string[]
Default: "all"
GentooPlatformModel object
name string
Constant: "Gentoo"
versions string[]
Default: "all"
HardenedBSDPlatformModel object
name string
Constant: "HardenedBSD"
versions string[]
Default: "all"
IOSPlatformModel object
name string
Constant: "IOS"
versions string[]
Default: "all"
JunosPlatformModel object
name string
Constant: "Junos"
versions string[]
Default: "all"
KaliPlatformModel object
name string
Constant: "Kali"
versions string[]
Default: "all"
MacOSXPlatformModel object
name string
Constant: "MacOSX"
versions string[]
Default: "all"
MageiaPlatformModel object
name string
Constant: "Mageia"
versions string[]
Default: "all"
NXOSPlatformModel object
name string
Constant: "NXOS"
versions string[]
Default: "all"
NetBSDPlatformModel object
name string
Constant: "NetBSD"
versions string[]
Default: "all"
OpenBSDPlatformModel object
name string
Constant: "OpenBSD"
versions string[]
Default: "all"
OpenWrtPlatformModel object
name string
Constant: "OpenWrt"
versions string[]
Default: "all"
OracleLinuxPlatformModel object
name string
Constant: "OracleLinux"
versions string[]
Default: "all"
PAN-OSPlatformModel object
name string
Constant: "PAN-OS"
versions string[]
Default: "all"
RockyLinuxPlatformModel object
name string
Constant: "Rocky"
versions string[]
Default: "all"
SLESPlatformModel object
name string
Constant: "SLES"
versions string[]
Default: "all"
SmartOSPlatformModel object
name string
Constant: "SmartOS"
versions string[]
Default: "all"
SolarisPlatformModel object
name string
Constant: "Solaris"
versions string[]
Default: "all"
SynologyPlatformModel object
name string
Constant: "Synology"
versions string[]
Default: "all"
TMOSPlatformModel object
name string
Constant: "TMOS"
versions string[]
Default: "all"
UbuntuPlatformModel object
name string
Constant: "Ubuntu"
versions string[]
Default: "all"
Void_LinuxPlatformModel object
name string
Constant: "Void Linux"
versions string[]
Default: "all"
WindowsPlatformModel object
name string
Constant: "Windows"
versions string[]
Default: "all"
aosPlatformModel object
name string
Constant: "aos"
versions string[]
Default: "all"
collections string[]
complex_conditional boolean | string | string[]
eosPlatformModel object
name string
Constant: "eos"
versions string[]
Default: "all"
macOSPlatformModel object
name string
Constant: "macOS"
versions string[]
Default: "all"
opensusePlatformModel object
name string
Constant: "opensuse"
versions string[]
Default: "all"
os10PlatformModel object
name string
Constant: "os10"
versions string[]
Default: "all"
platforms AIXPlatformModel | AlmaLinuxPlatformModel | AlpinePlatformModel | AmazonPlatformModel | AmazonLinuxPlatformModel | aosPlatformModel | ArchLinuxPlatformModel | AstraLinuxPlatformModel | ClearLinuxPlatformModel | CumulusPlatformModel | NetBSDPlatformModel | DebianPlatformModel | DellOSPlatformModel | DevuanPlatformModel | DragonFlyBSDPlatformModel | ELPlatformModel | eosPlatformModel | FedoraPlatformModel | FreeBSDPlatformModel | GenericBSDPlatformModel | GenericLinuxPlatformModel | GenericUNIXPlatformModel | GentooPlatformModel | HardenedBSDPlatformModel | IOSPlatformModel | JunosPlatformModel | KaliPlatformModel | macOSPlatformModel | MacOSXPlatformModel | MageiaPlatformModel | NXOSPlatformModel | OpenBSDPlatformModel | opensusePlatformModel | OpenWrtPlatformModel | OracleLinuxPlatformModel | os10PlatformModel | PAN-OSPlatformModel | RockyLinuxPlatformModel | SLESPlatformModel | SmartOSPlatformModel | SolarisPlatformModel | SynologyPlatformModel | TMOSPlatformModel | UbuntuPlatformModel | vCenterPlatformModel | Void_LinuxPlatformModel | vSpherePlatformModel | WindowsPlatformModel[]
vCenterPlatformModel object
name string
Constant: "vCenter"
versions string[]
Default: "all"
vSpherePlatformModel object
name string
Constant: "vSphere"
versions string[]
Default: "all"

Examples

"meta/main.yml"