ansible.playbook.role package

ansible.playbook.role.hash_params(params)[source]
class ansible.playbook.role.Role(play=None)[source]

Bases: ansible.playbook.base.Base, ansible.playbook.become.Become, ansible.playbook.conditional.Conditional, ansible.playbook.taggable.Taggable

get_name()[source]
static load(role_include, play, parent_role=None)[source]
add_parent(parent_role)[source]

adds a role to the list of this roles parents

get_parents()[source]
get_default_vars(dep_chain=[])[source]
get_inherited_vars(dep_chain=[])[source]
get_role_params(dep_chain=[])[source]
get_vars(dep_chain=[], include_params=True)[source]
get_direct_dependencies()[source]
get_all_dependencies()[source]

Returns a list of all deps, built recursively from all child dependencies, in the proper order in which they should be executed or evaluated.

get_task_blocks()[source]
get_handler_blocks()[source]
has_run(host)[source]

Returns true if this role has been iterated over completely and at least one task was run

compile(play, dep_chain=None)[source]

Returns the task list for this role, which is created by first recursively compiling the tasks for all direct dependencies, and then adding on the tasks for this role.

The role compile() also remembers and saves the dependency chain with each task, so tasks know by which route they were found, and can correctly take their parent’s tags/conditionals into account.

serialize(include_deps=True)[source]
deserialize(data, include_deps=True)[source]
set_loader(loader)[source]

Submodules

ansible.playbook.role.definition module

class ansible.playbook.role.definition.RoleDefinition(play=None, role_basedir=None, variable_manager=None, loader=None)[source]

Bases: ansible.playbook.base.Base, ansible.playbook.become.Become, ansible.playbook.conditional.Conditional, ansible.playbook.taggable.Taggable

static load(data, variable_manager=None, loader=None)[source]
preprocess_data(ds)[source]
get_role_params()[source]
get_role_path()[source]

ansible.playbook.role.include module

class ansible.playbook.role.include.RoleInclude(play=None, role_basedir=None, variable_manager=None, loader=None)[source]

Bases: ansible.playbook.role.definition.RoleDefinition

A derivative of RoleDefinition, used by playbook code when a role is included for execution in a play.

static load(data, play, current_role_path=None, parent_role=None, variable_manager=None, loader=None)[source]

ansible.playbook.role.metadata module

class ansible.playbook.role.metadata.RoleMetadata(owner=None)[source]

Bases: ansible.playbook.base.Base

This class wraps the parsing and validation of the optional metadata within each Role (meta/main.yml).

static load(data, owner, variable_manager=None, loader=None)[source]

Returns a new RoleMetadata object based on the datastructure passed in.

serialize()[source]
deserialize(data)[source]

ansible.playbook.role.requirement module

class ansible.playbook.role.requirement.RoleRequirement[source]

Bases: ansible.playbook.role.definition.RoleDefinition

Helper class for Galaxy, which is used to parse both dependencies specified in meta/main.yml and requirements.yml files.

static repo_url_to_role_name(repo_url)[source]
static role_spec_parse(role_spec)[source]
static role_yaml_parse(role)[source]
static scm_archive_role(src, scm='git', name=None, version='HEAD')[source]