Model: view/HcsMoveUsersVIEW

Move Users

Overview

You can move users between any hierarchy nodes at or below the hierarchy node where the users were originally created or synced in. Typically, users synced in at a Customer hierarchy node are moved to various customer sites.

When moving a user, you will choose their role at the target hierarchy.

Note

The Move Users page in VOSS Automate can be accessed via:

User Management > Move Users.
Overbuild > Move Users.

Alternatively, use the Search function in VOSS Automate to locate Move Users.

You will need to consider the restrictions that apply when moving users:

Scenario	Description
Moving users pushed to CUCM	CUCM users can only be moved down the hierarchy. For example, from Customer to Site. A Network Device List (NDL) containing the same CUCM the users were pushed to must be referenced at or below the target hierarchy node.
Moving users between sites	(Enterprise and Provider) You can't move users between customers. (Enterprise deployments) You can't move users from one site to another site as this will fail with dialplan errors. (Provider deployments) You can only move users between sites that: Reference the same NDL Have the same type of site dial plan Are associated with the same country

Note

When moving a user for SLC dialplan the lines associated to the agent line and the shared line show warnings in the form of logs.

Action	Description
Move users by filters	Moves users based on one or more user attributes, for example, City or Street. At Move From Hierarchy, select the hierarchy node from which you are moving the user. At Filters, choose one or more move filters from the Available list, and click the arrow to move the filters to the Selected list. Click the up/down arrows to change the order of the filters, which determines the order in which they are applied.
Move users by usernames	Moves multiple users at once, by their username (bulk move). At Move From Hierarchy, choose the hierarchy node from which you are moving the users. From the Move To Hierarchy drop-down, choose the target hierarchy node. From the Set Default Role drop-down, choose the default role for the moved users. This default role will be assigned to the moved users unless valid LDAP Custom Role Mappings have been configured, which take precedence over the default role. Click Users +, and from the drop-down, choose the user to move, repeat for each user you want to move. Alternatively select the Move All Users checkbox to select all the users.
Move user by username	Move a single user, by their username. At User, choose the user to move. At Move To Hierarchy, choose the target hierarchy node. From the Set Default Role drop-down, choose the default role to assign to the moved user. This default role will be assigned to the moved users unless valid LDAP Custom Role Mappings have been configured, which take precedence over the default role.

Move users between sites with non-SLC dial plans

When moving a user with their devices and services between sites with a non-SLC dial plan configured, VOSS Automate checks the following conditions:

Both sites must be configured with a SLC dial plan.
Both sites must use the same NDL.
Both sites are in the same country.
The SyncTo hierarchy is a parent of both sites.
The target site data/SiteDefaultsDoc contains the required default settings (that is, they are not empty nor null).
The role is valid at the target site.

When moving a user from one (non-SLC) site to another (non-SLC) site, the following models and relations are moved with the user:

relation/User
relation/Voicemail
relation/Subscriber
relation/SparkUser
relation/LineRelation
relation/HcsCucmCcTagREL
data/InternalNumberInventory

Various fields are updated for the target site (by the target site's site defaults) for the models that are moved. These fields include (but are not limited to), the following:

Voicemail Pilot Numbers
Unified CM Device Pool
Unified CM Location
Unified CM Region, and others

The following fields are updated for the device/cucm/Line model:

Calling Search Space Name
Route Partition Name
Share Line Appearance Css Name

The following models are updated for relation/Subscriber:

Device Profile
Remote Destination Profile
Phones

Each of these models contains a Lines field, which in turn can contain individual lines. In a site-to-site move, the E164 Mask and Route Partition Name fields are updated for each line contained in these models.

Additionally, the move updates some fields within these individual models:

Remote Destination Profile
- Device Pool Name
- Route Partition Name within the Line Associations
Phones
- Device Pool Name
- Location Name

You will need to update these values if you wish to use the overbuild with your existing CUCM data in the future.

The following models trigger a warning message when you attempt to move them from one site to another. While VOSS Automate does not prevent you from moving these models, a system message describes the possible implications for moving them:

E.164 associations
Call pickup groups
Hunt lists

Note

When using an API for a older version of VOSS Automate (prior to v11.5.1), the Move Users function has the previous behavior. Devices and services do not move with a user.

Move users between non-SLC sites with directory number routing configured

For moves between non-SLC sites with directory number routing (DNR) configured at either site, a system message is triggered to warn that any lines associated to the user being moved may not work correctly unless you take one of the recommended actions provided. See the Advanced Configuration Guide to perform the first recommended action.

Move users between sites with SLC dial plan configured

When moving users between sites with a SLC dial plan configured, the required conditions are the same as with non-SLC plans. The only difference is that no error is triggered when the system check detects an SLC dial plan configuration for the customer.

Note

When moving users from a dial plan site to a non-dial plan site, the users are set to a default CSS.

When moving users from one SLC site to another SLC site, the same models and relations are moved as for sites with non-SLC dial plans, with the following exceptions:

When moving relation/Subscriber -> Lines:
- Lines are disassociated from all phones and the relation.
- Removing the line from Subscriber Management > Phones should remove the primary line from the relation.

These models are not handled when moving SLC dial plans, because the line does not move:

Internal Number Inventory (INI)
E.164 Association
E164 Inventory
Call Pickup Group
Hunt List

The following models trigger a warning message when you attempt to move them from one site to another. While VOSS Automate does not prevent you from moving these models, a system message notifies you of the possible implications of moving them:

Agent line associations
Lines associated to a subscriber's phones, device profile, or RDP
Voicemail

Moving Microsoft Users

Moving a Microsoft user manually (via User Management > Move User), also moves the following models:

device/msgraph/MsolUser
device/msteamsonline/CsOnlineUser
device/msexchangeonline/UserMailbox

These models are moved regardless of the source and target hierarchies.

Move Users

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

You can move users between any hierarchy nodes at or below the hierarchy node where the users were originally created or synced in. Typically, users synced in at a customer hierarchy node are moved to various customer sites.

When moving users, choose an appropriate role for the target hierarchy from the following drop-down: Move To Role

Restrictions that apply when moving users

The table describes restritions that apply when moving users:

Scenario	Restrictions
Moving users that have been pushed to Cisco Unified Communications Manager	Cisco Unified Communications Manager users can only be moved down the hierarchy. An NDL containing the same Cisco Unified Communications Manager that the users were pushed to must be referenced at or below the target hierarchy node.
Moving users between sites	You cannot move users between customers. You can move users only between sites that: Reference the same NDL Have the same type of site dial plan Have the same country

Different methods for moving users

The table describes three ways to move users:

Move users by filters	Choose users to move, based on one or more user attributes, for example, City or Street.
Move users by usernames	Move multiple users at once (bulk move).
Move user by username	Move a single user.

Note

When moving a user for SLC dialplan the lines associated to the agent line and the shared line show warnings in the form of logs.
User at site level cannot be moved.

Model Details: view/HcsMoveUsersVIEW

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title		Description	Details
Action		The type of Move action to perform.	Field Name: move_action Type: String Choices: ["Move users by filters", "Move users by usernames", "Move user by username"]
Action		The type of Move action to perform. This attribute is deprecated and move_action should be used instead.	Field Name: action Type: String Choices: ["Move users by filters", "Move users by usernames", "Move user by username"]
User		Name of individual user who will be moved.	Field Name: one_username Type: String Choices: [" "]
Note		Information regarding the specified action.	Field Name: note Type: String
Move From Hierarchy		The name of the hierarchy node from which the user will be moved if the conditions are satisfied.	Field Name: move_from_hn Type: String
Move From Hierarchy Count		The number of the hierarchy nodes that match the from username. Default: TBD	Field Name: move_from_hn_count Type: String Default: TBD
Move To Hierarchy		The name of the hierarchy node to which the user will be moved if the conditions are satisfied.	Field Name: move_to_hn Type: String Choices: [" "]
Set Default Role		The default role to assign to the moved user (if no other LDAP Custom Role Mappings are applicable for the moved user, then this fallback/default role will be applied)	Field Name: move_to_role_user Type: String Choices: [" "]
Move All Users		Move all the users at the move from hierarchy. Default: false	Field Name: move_all Type: Boolean Default: false
	Filters	Select move filters to be applied when the transaction is submitted.	Field Name: filters.[n] Type: Array
	Users	Names of users who will be moved.	Field Name: usernames.[n] Type: Array