Class: Ansible::Ruby::Modules::Os_server_actions

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server_actions.rb

Overview

Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false.

Instance Method Summary collapse

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

#action ⇒ :stop, ...

Returns Perform the given action. The lock and unlock actions always return changed as the servers API does not provide lock status.

Returns:

  • (:stop, :start, :pause, :unpause, :lock, :unlock, :suspend, :resume, nil) —

    Perform the given action. The lock and unlock actions always return changed as the servers API does not provide lock status.



23
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server_actions.rb', line 23

attribute :action

#server ⇒ String

Returns Name or ID of the instance.

Returns:

  • (String) —

    Name or ID of the instance



11
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server_actions.rb', line 11

attribute :server

#timeout ⇒ Integer?

Returns The amount of time the module should wait for the instance to perform the requested action.

Returns:

  • (Integer, nil) —

    The amount of time the module should wait for the instance to perform the requested action.



19
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server_actions.rb', line 19

attribute :timeout

#wait ⇒ String?

Returns If the module should wait for the instance action to be performed.

Returns:

  • (String, nil) —

    If the module should wait for the instance action to be performed.



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server_actions.rb', line 15

attribute :wait