Documentationcurrent version
Help us improve the docs by fixing typos and proposing enhancements.

Nikita

Action "lxc.stop"

Stop a running Linux Container.

Example

const { $status } = await nikita.lxc.stop({
  container: "myubuntu",
  wait: true,
  wait_retry: 5,
});
console.info(`The container was stopped: ${$status}`);

Schema definitions

definitions =
  config:
    type: 'object'
    properties:
      'container':
        $ref: 'module://@nikitajs/lxd/src/init#/definitions/config/properties/container'
      'wait':
        type: 'boolean'
        default: false
        description: """
        Wait for container to be stopped before finishing action.
        """
      'wait_retry':
        type: 'integer'
        default: 3
        description: """
        Maximum number of checks on container state, default to 3.
        """
      'wait_interval':
        type: 'integer'
        default: 2000
        description: """
        Time interval between each container state check in ms, default to 2s.
        """
    required: ['container']

Handler

handler = ({config}) ->
  await @execute
    command: """
    lxc list -c ns --format csv | grep '#{config.container},STOPPED' && exit 42
    lxc stop #{config.container}
    """
    code_skipped: 42
  if config.wait
    await @execute.wait
      $shy: true
      command: "lxc info #{config.container} | grep 'Status: Stopped'"
      retry: config.wait_retry
      interval: config.wait_interval
  {}

Exports

module.exports =
  handler: handler
  metadata:
    definitions: definitions
Edit on GitHub
Navigate
About

Nikita is an open source project hosted on GitHub and developed by Adaltas.