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

Nikita

Action "system.group.remove"

Create or modify a Unix user.

Callback parameters

  • $status
    Value is "true" if user was created or modified.

Example

const {$status} = await nikita.group.remove({
  name: 'a_user'
})
console.info(`User is removed: ${$status}`)

The result of the above action can be viewed with the command cat /etc/passwd | grep myself producing an output similar to "a_user:x:490:490:A System User:/home/a_user:/bin/bash". You can also check you are a member of the "wheel" group (gid of "10") with the command id a\_user producing an output similar to "uid=490(hive) gid=10(wheel) groups=10(wheel)".

Schema definitions

definitions =
  config:
    type: 'object'
    properties:
      name:
        type: 'string'
        description: '''
        Name of the group to remove.
        '''
    required: ['name']

Handler

handler = ({metadata, config}) ->
  @execute
    command: "groupdel #{config.name}"
    code: [0, 6]

Exports

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

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