set_rse_field

Use the set_rse_field command to set the value for a specified field in the currently selected restricted shell environment that is stored in memory. The set_rse_field command does not set the field value stored in Active Directory for this restricted shell environment.

This command only sets the field value that is stored in memory. You must save the restricted shell environment using the save_rs_env command for your changes to take effect in Active Directory. If you select another restricted shell environment or end the ADEdit session before saving the currently selected restricted shell environment, your changes will be lost.

You can only use the set_rse_field command if the currently selected zone is a classic4 zone. The command does not work in other type of zones.

Zone type

Classic only

Syntax

set_rse_field field value

Abbreviation

srsef

Options

This command takes no options.

Arguments

This command takes the following argument:

Argument Type Description

field

string

Required. Specifies the name of the field whose value you want to set. The only possible value is:

  • description: Text describing the restricted shell environment.

value

depends on field

Required. Specifies the value to assign to the specified field.

In most cases, you can assign an empty string to unset a field value.

Return value

This command returns nothing if it runs successfully.

Examples

set_rse_field description {This string is the restricted shell description}

This example sets the description field for the current restricted shell environment to the “This string is the restricted shell description” text string.

Related commands

Before you use this command, you must have a currently selected role stored in memory. The following commands enable you to view and select the role to work with restricted shell environments:

  • get_rs_envs returns a Tcl list of restricted shell environments.
  • list_rs_envs lists to stdout the restricted shell environments.
  • new_rs_env creates a new restricted shell environment and stores it in memory.
  • select_rs_env retrieves a restricted shell environment from Active Directory and stores it in memory.

After you have a restricted shell environment stored in memory, you can use the following commands to work with its fields:

  • delete_rs_env deletes the current restricted shell environment from Active Directory and from memory.
  • get_rse_field reads a field value from the current restricted shell environment.
  • save_rs_env saves the restricted shell environment to Active Directory.