Use the get_rse_field command to return a field value from the currently selected restricted shell environment stored in memory.

The get_rse_field command does not query Active Directory for the restricted shell environment. If you have changed field values using ADEdit without saving the restricted shell environment to Active Directory, the field value you retrieve using get_rse_field won’t match the field value for the restricted shell environment that is stored in Active Directory.

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

Zone type

Classic only


get_rse_field field




This command takes no options.


This command takes the following argument:

Argument Type Description



Required. Specifies the name of the field whose value to get. The only possible value is:

description: Returns a text string describing the restricted shell environment.

Return value

This command returns a field value, which varies in type depending on the data type stored by the field.


get_rse_field description

This command returns the content of the description field. For example:

This is the restricted shell environment description

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.
  • save_rs_env saves the restricted shell environment to Active Directory.
  • set_rse_field sets a field value in the current restricted shell environment.