Class: Ansible::Ruby::Modules::Win_scheduled_task

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb

Overview

Manage scheduled tasks

Instance Method Summary

• #argument ⇒ Object^?

  Arguments to provide scheduled task action.

• #days_of_week ⇒ Object^?

  Days of the week to run a weekly task, not idempotent.

• #description ⇒ Object^?

  The description for the scheduled task.

• #enabled ⇒ Boolean^?

  Enable/disable the task.

• #execute ⇒ Object^?

  Command the scheduled task should execute.

• #frequency ⇒ :daily, ...

  The frequency of the command, not idempotent.

• #name ⇒ Object

  Name of the scheduled task.

• #path ⇒ String^?

  Folder path of scheduled task.

• #state ⇒ :present, :absent

  State that the task should become.

• #time ⇒ Object^?

  Time to execute scheduled task, not idempotent.

• #user ⇒ Object^?

  User to run scheduled task as.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#argument ⇒ Object^?

Returns Arguments to provide scheduled task action.

Returns:

• (Object, nil) —

  Arguments to provide scheduled task action

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 32

attribute :argument

#days_of_week ⇒ Object^?

Returns Days of the week to run a weekly task, not idempotent.

Returns:

• (Object, nil) —

  Days of the week to run a weekly task, not idempotent

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 42

attribute :days_of_week

#description ⇒ Object^?

Returns The description for the scheduled task.

Returns:

• (Object, nil) —

  The description for the scheduled task

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 15

attribute :description

#enabled ⇒ Boolean^?

Returns Enable/disable the task.

Returns:

• (Boolean, nil) —

  Enable/disable the task

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 18

attribute :enabled

#execute ⇒ Object^?

Returns Command the scheduled task should execute.

Returns:

• (Object, nil) —

  Command the scheduled task should execute

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 29

attribute :execute

#frequency ⇒ :daily, ...

Returns The frequency of the command, not idempotent.

Returns:

• (:daily, :weekly, nil) —

  The frequency of the command, not idempotent

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 35

attribute :frequency

#name ⇒ Object

Returns Name of the scheduled task.

Returns:

• (Object) —

  Name of the scheduled task

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 11

attribute :name

#path ⇒ String^?

Returns Folder path of scheduled task.

Returns:

• (String, nil) —

  Folder path of scheduled task

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 45

attribute :path

#state ⇒ :present, :absent

Returns State that the task should become.

Returns:

• (:present, :absent) —

  State that the task should become

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 22

attribute :state

#time ⇒ Object^?

Returns Time to execute scheduled task, not idempotent.

Returns:

• (Object, nil) —

  Time to execute scheduled task, not idempotent

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 39

attribute :time

#user ⇒ Object^?

Returns User to run scheduled task as.

Returns:

• (Object, nil) —

  User to run scheduled task as

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_scheduled_task.rb', line 26

attribute :user