remove_object_value

Use the remove_object_value command to remove a value from a multi-valued attribute of a specified Active Directory object. This command only affects the specified attribute for specified object in Active Directory. The command does not change the currently selected Active Directory object in memory, if there is one.

If the field or value to be removed isn’t valid, Active Directory will report an error and remove_object_value won’t remove the value.

This command is useful for fields that may be very large—members of a group, for example.

Zone type

Not applicable

Syntax

remove_object_value dn field value

Abbreviation

rov

Options

This command takes no options.

Arguments

This command takes the following arguments:

Argument Type Description

dn

string

Required. Specifies the distinguished name (DN) of the Active Directory object from which to remove a value.

field

string

Required. Specifies the name of a multi-valued attribute in the currently selected Active Directory object from which to remove the value.

This argument can be any field that is valid for the type of the Active Directory object you have specified using the dn argument. For example, if the Active Directory object specified is a computer object, the field argument might be operatingSystem.

value

 

Required. Specifies the value to remove from the field. The data type of the value depends on the field you specify.

Return value

This command returns nothing if it runs successfully.

Examples

remove_object_value cn=groups,dc=acme,dc=com users adam.avery

This example removes the value adam.avery from the users field of the groups object in Active Directory.

Related commands

The following commands enable you to view and select the object to work with:

  • get_objects performs an LDAP search of Active Directory and returns a Tcl list of the distinguished names of objects matching the search criteria.
  • new_object creates a new Active Directory object and stores it in memory.
  • select_object retrieves an object and its attributes from Active Directory and stores it in memory.

After you have an Active Directory object stored in memory, you can use the following commands to work with that object’s attributes, delete the object, or save information for the object:

  • add_object_value adds a value to a multi-valued field attribute of the currently selected Active Directory object.
  • delete_object deletes the selected Active Directory object from Active Directory and from memory.
  • delete_sub_tree deletes an Active Directory object and all of its children from Active Directory.
  • get_object_field reads a field value from the currently selected Active Directory object.
  • save_object saves the selected Active Directory object with its current settings to Active Directory.
  • set_object_field sets a field value in the currently selected Active Directory object.