Realm-Specific Delete Command

The ACLI provides a way to delete a specific realm and the configurations (objects) associated with that realm. You use the delete realm-specifics command with the name of the realm you want to delete. Not only does the Oracle Communications Session Border Controller delete that realm, it also deletes the configurations where that realm is also used as a primary or foreign key—such as steering pools, session agents, and SIP interfaces. A complete list of configurations subject to deletion appears below.

The Oracle Communications Session Border Controller safeguards against unintentionally deleting configurations by showing you a complete list of the configurations it is about to delete, warns you that you are about to the delete the realm, and then asks you for confirmation. The list of candidates for deletion appears each with its key identifier so that you can more easily recognize it. You must type in a y for yes or n for no to move forward.

Despite these safeguards, you should use the delete realm-specifics command with the utmost care. Oracle recommends that only advanced users work with this command. In fact, the command appears in the configuration menu, to which only Superusers have access.

Deleted Configurations

This section provides a list of the configuration that use the name of realm either as a primary or as a foreign key. These are the configuration that you can remove from your configuration when you delete a specific realm.

ACLI Configuration Name ACLI Parameter Value
access-control realm-id
call-recording-server primary-realm

secondary-realm

dns-config client-realm
enum-config realm-id
ext-policy-server realm
h323, h323-stack realm-id
lawful-intercept (associated parameters; specified in Oracle LI support documentation)
local-policy source-realm
realm-config identifier
session-agent realm-id
sip-features realm
sip-interface realm-id
sip-nat realm-id
static-flow in-realm-id

out-realm-id

steering-pool realm-id
surrogate-agent realm-id

There are configurations (objects) that use realms but do not reference them directly either as a primary or foreign key. The Oracle Communications Session Border Controller does not delete these configurations when you use the delete realm-specifics command:

  • media-policy
  • class-policy
  • translation-rules
  • sip-manipulation

Note:

This command cannot delete realms associated with network management control configurations.

Deleted Parameter Values

For other configurations that reference realms, only the parameters containing realm identifiers are cleared while the object as a whole remains. By confirming you want to delete the realm, the Oracle Communications Session Border Controller clears the parameters set out in this section, the Oracle Communications Session Border Controller informs you of the configuration object and the parameter within it that will be affected.

The following table shows you which parameters are cleared.

ACLI Configuration Name ACLI Parameter Value(s)
dns-config server-realm
local-policy source-realm

next-hop

realm

media-manager home-realm-id
realm-config parent-realm

dns-realm

ext-policy-svr

realm-group source-realm

destination-realm

session-agent egress-realm
session-group dest
sip-config egress-realm-id

home-realm-id

Deleted Parameter Configuration

This section shows you how to use the delete realm-specifics command. Remember that you need to be in Superuser mode to use it.

To use the delete realm-specifics command, you need to know the identifier for the realm (and the other configurations associated with the realm) that you want to delete.

These instructions and examples do not include information for parameters that will be emptied for configurations that will otherwise be left intact. This information will appear in the following form: <attribute> <attribute value> removed from <object name/configuration name> with key <key value>.

To delete a specific realm and its associated configurations:

  1. In Superuser mode, type configure terminal and press Enter.
    ORACLE# configure terminal
    ORACLE(configure)#
  2. Type delete realm-specifics, a Space, and the name of the realm you want deleted. The press Enter.

    After you press Enter, the system displays a list of all configurations on which the deletion will have an impact. It also warns you that you are about to delete the realm.

    ORACLE(configure)# delete realm-specifics peer_1
    RealmConfig with key identifier=peer_1 will be deleted
    SteeringPool with key ip-address=192.168.0.11 start-port=21000 realm-id=peer_1 w
    ill be deleted
    SessionAgent with key hostname=127.0.0.11 will be deleted
    SipInterface with key realm-id=peer_1 will be deleted
    SipNatConfig with key realm-id=peer_1 will be deleted
    WARNING: you are about to delete the realm!
    Delete the realm? [y/n]?:
  3. At the end of the display, the system asks you to confirm (by typing a y) or abort (by typing an n) the deletion.
    Delete the realm? [y/n]?: y

    If you confirm the deletion, the system will list all of the configurations that have been removed.

    RealmConfig with key identifier=peer_1 deleted
    SteeringPool with key ip-address=192.168.0.11 start-port=21000 realm-id=peer_1 d
    deleted
    SessionAgent with key hostname=127.0.0.11 deleted
    SipInterface with key realm-id=peer_1 deleted
    SipNatConfig with key realm-id=peer_1 deleted
    ORACLE(configure)#

    When you abort the deletion, the Oracle Communications Session Border Controller will return you to the ORACLE(configure)# system prompt.