Documentation : Command Line Documentation : Group Management : Erase Group

Erase Group

Usage

erase group $group

Description

The command erase group is used to remove a Virtual Group record for REVLY. This action cannot be undone.

Symbol

erase group

Cardinal

action-identifier

Language

Group Admin

Module

Admin

Parameters

LDAP Suffix

usage: ldap suffix $ldapsuffix

description: The base search path of the LDAP tree.

default: revly

Actions

- Generate a LDIF file to remove the group information.

- Execute ldapmodify to remove the group from OpenLDAP.

Template

# Erase virtualGroup
dn: group=:#GROUP#:,o=groups,dc=:#LDAP_SUFFIX#:
changetype: delete

Return Codes

CodeHuman Readable Output
0Erased the group '$group'
1The group '$group' does not exist.

Example

Input

erase group example

Generated LDIF file

# Create virtualGroup
dn: group=example,o=groups,dc=revly
changetype: delete

Output

Erased the group 'example'.

Returncode

0