Reconfiguration command options

Last Updated : Jun 05, 2023 |

The sbceconfigurator.py command is used for many system-level reconfiguration tasks. This table summarizes the options available when reconfiguring your system.

Caution:

When using the sbceconfigurator.py command, you must use only the command options shown in this table. Do not use any other command options.

Description

Usage examples

The change-dns-ip-fqdn option changes the DNS configuration. When using this command, you must enter the DNS IP address, and you can optionally include the DNS FQDN (shown as [FQDN] in the examples). Depending on whether you have just a single server or both primary and secondary servers, you can use the command to make the following changes:

  • Change primary only – first two methods shown in the examples

  • Change primary and secondary

  • Change secondary only

  • Remove secondary – used when you have both a primary and secondary and you only want to retain the primary system

sbceconfigurator.py change-dns-ip-fqdn New Primary DNS IP Address [FQDN]

sbceconfigurator.py change-dns-ip-fqdn New Primary DNS IP Address [FQDN],Current Secondary DNS IP Address [FQDN]

sbceconfigurator.py change-dns-ip-fqdn New Primary DNS IP Address [FQDN],New Secondary DNS IP Address [FQDN]

sbceconfigurator.py change-dns-ip-fqdn Current Primary DNS IP Address [FQDN],New Secondary DNS IP Address [FQDN]

sbceconfigurator.py change-dns-ip-fqdn Current Primary DNS IP Address [FQDN]

The change-ems-ip option does the following:

  • Changes the primary or active EMS IP address on the secondary or standby EMS.

  • Changes the secondary or standby EMS IP address on the primary or active EMS and all the SBC servers connected to EMS.

  • Changes the primary or active EMS IP address on the connected SBC servers, which were not reachable while changing the primary or active EMS IP address.

sbceconfigurator.py change-ems-ip Old EMS IP Address New EMS IP Address

The change-hostname option changes the host name.

sbceconfigurator.py change-hostname HOSTNAME

The change-ip-gw-mask option changes the management IP address, gateway, and subnet mask.

sbceconfigurator.py change-ip-gw-mask Management IP Address Gateway IP Address Subnet Mask

The change-ntp-ip option changes the NTP IP address.

sbceconfigurator.py change-ntp-ip New NTP IP Address <yes/no> <<if yes provide PASSWORD>

The change-nw-passphrase option changes the network passphrase.

sbceconfigurator.py change-nw-passphrase Passphrase

The change-sbce-ip option changes the SBC IP address on the EMS database. Use the following steps to use this command:

  1. Change the management IP address, gateway, mask on the SBC server by using the change-ip-gw-mask option

  2. Run the change-sbce-ip option on the EMS CLI to notify the EMS about the SBC IP change.

sbceconfigurator.py change-sbce-ip Old SBC IP Address New SBC IP Address

The change-ssl-certs yes option changes the self-signed certificate for EMS and single SBC servers. This is an interactive command that steps you through changing the self-signed certificate.

The command prompts you for the following information:

  • First and Last Name: [Default=]

  • Organizational Unit: [Default=]

  • Organization: [Default=]

  • City or Locality: [Default=]

  • State or Province: [Default=]

  • Country Code (2 letter code ): [Default=]

sbceconfigurator.py change-ssl-certs yes

The view-timezone option displays the administered time zones. This is an interactive command that steps you through viewing a time zone.

sbceconfigurator.py view-timezone

The change-timezone option assigns a new time zone. This is an interactive command that steps you through selecting a time zone.

The command prompts you for the following information:

  • Location

  • Country

  • Time Zone

sbceconfigurator.py change-timezone

The gen-system-ssh-keys option generates system SSH keys.

sbceconfigurator.py gen-system-ssh-keys

The exchange-ems-keys option exchanges the SSH keys.

Use this command to copy SSH keys from the primary (or secondary, if present) EMS to SBC. Do this to ensure proper function of passwordless SSH between servers.

sbceconfigurator.py exchange-ems-keys

The factory-reset option resets the system to the factory default state. Use the following procedure:

  1. To uninstall the SBC device in a multiple server deployment from GUI, click Device Management > Devices and click Uninstall.

    This operation clears the device-specific configuration and is not required on EMS and a single server deployment.

  2. Run sbceconfigurator.py factory-reset.

    This operation clears the device-specific configuration on EMS or a single server deployment.

    Important:

    Run this command from either a serial console or VGA session. Do not run this command from an SSH putty session since network connectivity will be lost during this operation.

sbceconfigurator.py factory-reset

The re-configure option moves Avaya SBC from one EMS to other EMS. The option does the following:

  1. Convert SingleBox deployment to Seperate Box deployment and added to EMS.

    Usage example: sbceconfigurator.py re-configure

  2. Move Separate Box deployment from one EMS to other EMS.

    Usage example: sbceconfigurator.py re-configure

  3. Move HA Pair deployment from one EMS to other EMS.

    Usage example: sbceconfigurator.py re-configure

Note:

Ensure to run sbceconfigurator.py re-configure command on the PEER Avaya SBC once the first Avaya SBC comes back up after re-configure.

sbceconfigurator.py re-configure

The join-ha option converts Separate Avaya SBC to HA by adding another Avaya SBC device. Use the following procedure:

  1. Deploy new Avaya SBC and add to the EMS.

  2. Make the new Avaya SBC into Registered state.

  3. Run the sbceconfigurator.py join-ha command from new Avaya SBC cli.

    Command usage: sbceconfigurator.py join-ha

sbceconfigurator.py join-ha

generate-rest-credentials option is used to create the rest credentials. This command is supported from Release 10.1.2.

  • If you run the command in EMS, it will generate the rest credentials for all Avaya SBC associated with it and other EMS incase of active active EMS.

  • If you run the command in HA setup, it will generate the rest credentials for other box in Pair: EMS and secondary EMS if configured.

  • If you run the command in separate box, it will generate the rest credentials for EMS and Secondary EMS.

  • Single Box (EMS+SBC) is not supported.

sbceconfigurator.py generate-rest-credentials