Class: Ansible::Ruby::Modules::Async_status

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Async_status

Defined in:

lib/ansible/ruby/modules/generated/utilities/logic/async_status.rb

Overview

This module gets the status of an asynchronous task. This module is also supported for Windows targets.

Instance Method Summary

• #jid ⇒ Object

  Job or task identifier.

• #mode ⇒ :status, ...

  If C(status), obtain the status; if C(cleanup), clean up the async job cache (by default in C(~/.ansible_async/)) for the specified job I(jid).

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#jid ⇒ Object

Returns Job or task identifier.

Returns:

• (Object) —

  Job or task identifier

# File 'lib/ansible/ruby/modules/generated/utilities/logic/async_status.rb', line 13

attribute :jid

#mode ⇒ :status, ...

Returns if C(status), obtain the status; if C(cleanup), clean up the async job cache (by default in C(~/.ansible_async/)) for the specified job I(jid).

Returns:

• (:status, :cleanup, nil) —

  if C(status), obtain the status; if C(cleanup), clean up the async job cache (by default in C(~/.ansible_async/)) for the specified job I(jid).

# File 'lib/ansible/ruby/modules/generated/utilities/logic/async_status.rb', line 17

attribute :mode