Moving an account within KAZOO
User Stories
- I mistakenly added and configured a sub account under the wrong parent account; my “North Carolina” office should be under “East” and not “West.”
- I want to move a sub account from one home account to another parent account – for example, move my XXX East account from US to Canada?
Overview
There are two ways to achieve this:
- Use the Cluster Manager app. In the KAZOO environment.
- Execute an SSH command at the server level. This is an option available to Global Infrastructure clients who are experienced system administrators.
NOTE:
This process can be unsafe; it should only be used if an account was created under the wrong account in error, and needs to be moved.
USING CLUSTER MANAGER (OPTION 1)
-
Obtain the account ID of the account you want to move from.
This ID will referenced as MOVE_ACCOUNT from now on. This can be obtained from the UI via the Accounts Manager app.
- Open your Accounts app
- Navigate to the account you want to move to
- Select the account, and select Overview
-
Copy the account ID String and save it on a notepad
From Account:
2. Obtain the account ID of the account you want to move the MOVE_ACCOUNT TO
This ID will be referenced as DESTINATION_ACCOUNT from now on.
- Repeat the steps above and copy to a place that clearly labels this Account ID is the TO: Account ID number.
3. Browse to https://ui.zswitch.net and login using your credentials and the name of your account on our hosted platform (XYZ Parent Account)
- Open the Apps menu, and select the Cluster Manager app
-
Click the Scripts tab from within the Cluster Manager app
- Click the Red Button labeled Run Command
4. Type the command below into the command dialog box
sup crossbar_maintenance move_account MOVE_ACCOUNT DESTINATION_ACCOUNT
NOTE: While this process should take less than 5 seconds, you may want to increase the “Abort After” value to about 5 minutes. This should give ample time for the process to resolve before timing out and requiring a restart.
6. Click the Select Servers button
7. From the Cluster drop down, select the name of the cluster where the accounts live that you would like to move (pre, or prod). You do not need to select anything for Zone, or Services
8. Uncheck servers in the Filter Results section, so that you ONLY HAVE ONE server checked
NOTE: You MUST select the server that contains your KAZOO applications; a Freeswitch or Database only server will cause this process to fail. To ensure this, you can follow these steps:
- Filter your server list using kazoo_applications type of servers first.
- "Select All" to unselect everything.
- Reselect the first server on the. list.
9. Click NEXT
10. Click Run Tasks Now! to execute the command you typed into the dialog box, on the server that remained checked on the previous page.
11. Watch the "Running/Queued" section of the tasks tab to ensure the task completes.
You may need to refresh the list periodically, but clicking the refresh button (2 spinning arrows) at the top of the list. You can also go to the "Completed Logs" section to see that your "Run Command" task completed successfully.
12. Once the task is complete, confirm the account is now moved by re-opening the Accounts Manager app in the UI of your cluster.
ADVANCED USERS (OPTION 2)
This is an option available to Global Infrastructure clients who are experienced system administrators.
Via SSH:
-
Obtain the account ID of the account you want to move, I'll reference this ID as MOVE_ACCOUNT from now on. This can be obtained from the UI via the Accounts Manager app.
-
Obtain the account ID of the account you want to move the MOVE_ACCOUNT under, I will reference this ID as DESTINATION_ACCOUNT from now on. This can also be obtained from the UI via the Accounts Manager app.
-
SSH to one of the servers in your cluster where the account you want to move is assigned, and where kazoo_apps is running.
-
Run the command below:
sup crossbar_maintenance move_account MOVE_ACCOUNT DESTINATION_ACCOUNT
API Reference Doc:
docs.2600hz.com
https://docs.2600hz.com/dev/applications/crossbar/doc/accounts/#move-an-account
Edited by Emily R (show revisions)
Recommended Comments
There are no comments to display.