Package ganeti :: Module cmdlib :: Class LUShutdownInstance
[hide private]
[frames] | no frames]

Class LUShutdownInstance

source code


Shutdown an instance.

Instance Methods [hide private]
 
ExpandNames(self)
Expand names for this LU.
source code
 
BuildHooksEnv(self)
Build hooks env.
source code
 
CheckPrereq(self)
Check prerequisites.
source code
 
Exec(self, feedback_fn)
Shutdown the instance.
source code

Inherited from LogicalUnit: CheckArguments, DeclareLocks, HooksCallBack, __init__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  HPATH = "instance-stop"
  HTYPE = "INSTANCE"
  _OP_PARAMS = [_PInstanceName, _PIgnoreOfflineNodes, ("timeout"...
a list of opcode attributes, their defaults values they should get if not already defined, and types they must match
  REQ_BGL = False

Inherited from LogicalUnit: ssh

Instance Variables [hide private]

Inherited from LogicalUnit: dry_run_result

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

ExpandNames(self)

source code 

Expand names for this LU.

This method is called before starting to execute the opcode, and it should update all the parameters of the opcode to their canonical form (e.g. a short node name must be fully expanded after this method has successfully completed). This way locking, hooks, logging, ecc. can work correctly.

LUs which implement this method must also populate the self.needed_locks member, as a dict with lock levels as keys, and a list of needed lock names as values. Rules:

  • use an empty dict if you don't need any lock
  • if you don't need any lock at a particular level omit that level
  • don't put anything for the BGL level
  • if you want all locks at a level use locking.ALL_SET as a value

If you need to share locks (rather than acquire them exclusively) at one level you can modify self.share_locks, setting a true value (usually 1) for that level. By default locks are not shared.

This function can also define a list of tasklets, which then will be executed in order instead of the usual LU-level CheckPrereq and Exec functions, if those are not defined by the LU.

Examples:

 # Acquire all nodes and one instance
 self.needed_locks = {
   locking.LEVEL_NODE: locking.ALL_SET,
   locking.LEVEL_INSTANCE: ['instance1.example.com'],
 }
 # Acquire just two nodes
 self.needed_locks = {
   locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
 }
 # Acquire no locks
 self.needed_locks = {} # No, you can't leave it to the default value None
Overrides: LogicalUnit.ExpandNames
(inherited documentation)

BuildHooksEnv(self)

source code 

Build hooks env.

This runs on master, primary and secondary nodes of the instance.

Overrides: LogicalUnit.BuildHooksEnv

CheckPrereq(self)

source code 

Check prerequisites.

This checks that the instance is in the cluster.

Overrides: LogicalUnit.CheckPrereq

Exec(self, feedback_fn)

source code 

Shutdown the instance.

Overrides: LogicalUnit.Exec

Class Variable Details [hide private]

_OP_PARAMS

a list of opcode attributes, their defaults values they should get if not already defined, and types they must match
Value:
[_PInstanceName, _PIgnoreOfflineNodes, ("timeout", constants.DEFAULT_S\
HUTDOWN_TIMEOUT, ht.TPositiveInt),]