Class: Ansible::Ruby::Modules::Os_server_action

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb,
lib/ansible/ruby/modules/generated/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. When I(action) is ‘rebuild’, then I(image) parameter is required.

Instance Method Summary collapse

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

#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, :rebuild, nil) —

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



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb', line 24

attribute :action

#availability_zone ⇒ Object?

Returns Ignored. Present for backwards compatibility.

Returns:

  • (Object, nil) —

    Ignored. Present for backwards compatibility



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb', line 31

attribute :availability_zone

#image ⇒ Object?

Returns Image the server should be rebuilt with.

Returns:

  • (Object, nil) —

    Image the server should be rebuilt with



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb', line 28

attribute :image

#server ⇒ String

Returns Name or ID of the instance.

Returns:

  • (String) —

    Name or ID of the instance



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb', line 12

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.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb', line 20

attribute :timeout

#wait ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server_action.rb', line 16

attribute :wait