Search <book_title>...

APTARE IT Analytics Help

Last Published: 2022-11-10

Product(s): APTARE IT Analytics (10.6)

Organize clients into groups by management server

This utility enables you to create a hierarchy of management servers and links all clients that are members of the management server into the respective host group. For example, in a NetBackup environment if you have two master servers called master1 and master2, this utility creates host groups named master1 and master2 and links the master server's clients into the corresponding group. Two versions of this utility are available:

Move clients into a Master Server Group:
See Organize clients into groups by management server.
Move clients into a Master Server Group & Exclude the Policy Client & Cascade to Sub-groups:
See Organize clients into groups by management server.

Basic Usage with 4 Parameters

execute nbu_adaptor_pkg.moveClientsIntoMasterGroups
( <source_group_id>,<destination_group_id>, 
<move_clients>, <latest_master_only> );

Example: execute nbu_adaptor_pkg.moveClientsIntoMasterGroups(300000, 300010, 1, 1);

source_group_id is the internal group ID of the host group hierarchy to traverse.

destination_group_id is the group ID in which the host group for your master servers groups will be created. Create a host group under source_group_id called Masters or Management Servers and use the group ID of this new host group for the second parameter.

See Identifying a host group ID.

When you organize by master server, if a host group exists anywhere under the source group hierarchy with the name of the master server, the routine associates the clients with that folder and does not create a new folder under the destination folder. This association occurs whether you explicitly specify the destination folder or if the destination is NULL. However, if you pass a source folder that is at a lower level, the routine only checks for a folder under that hierarchy. If you specify NULL as the destination, the routine will create (if it does not exist already) a group called "NetBackup" under the Source group ID. It then creates a host group called "Master Servers" under the "NetBackup" group.

move_clients If set to 0, the clients link into the respective host group and remain in their original host group location. If set to 1, all the clients move from the source host group and into the respective host groups.

The utility processes and organizes all clients of the source group hierarchy into the target master server grouping. However, if the move_clients flag is set to 1, the utility removes only clients in the top level source_group_id group--and those already organized in lower level sub-groups remain.

latest_master_only defaults to 0, but can be set to 1, indicating organization by the latest master server. If a client is backed up by two master servers, or if a client was backed up by master server A in the past, but is now backed up by master server B, setting this flag to true will result in the client being organized by the latest master server.

Usage with 6 Parameters

execute nbu_adaptor_pkg.moveClientsIntoMasterGroups
( <source_group_id>,<destination_group_id>, 
<cascade_source_group>, <move_clients>, 
<latest_master_only>, <exclude_policy_client>);

Example: exec moveClientsIntoMasterGroups(300000, 300010, 1, 1, 1, 0);

source_group_id is the internal group ID of the host group hierarchy to traverse.

destination_group_id is the group ID in which the new host group for your master servers will be created. Create a host group under source_group_id called Masters or Management Servers and use the group ID of this new host group for the second parameter.

See Identifying a host group ID.

When you organize by master server, if a host group exists anywhere under the source group hierarchy with the name of the master server, the routine associates the clients with that folder and does not create a new folder under the destination folder. This association occurs whether you explicitly specify the destination folder or if the destination is NULL. However, if you pass a source folder that is at a lower level, the routine only checks for a folder under that hierarchy. If you specify NULL as the destination, the routine will create (if it does not exist already) a host group called "NetBackup" under the Source group ID. It then creates a host group called "Master Servers" under the "NetBackup" host group.

cascade_source_groupcan be set to 0= Do not include sub-groups, 1= Include sub-groups. Use cascade_source_group to find and re-sort all of the defined host groups that are under the source group. Use this parameter so that you do not have to move all of your clients to the top before re-sorting.

The utility processes and organizes all clients of the source group hierarchy into the target master server grouping. However, if the move_clients flag is set to 1, the utility removes only clients in the top-level source_group_id group--and those already organized in lower-level sub-groups remain.

latest_master_only defaults to 0, but can be set to 1, indicating organization by the latest master server. If a client is backed up by two master servers, or if a client was backed up by master server A in the past, but is now backed up by master server B, setting this flag to true will result in the client being organized by the latest master server.

exclude_policy_client defaults to 0, but can be set to 1, indicating that you want to organize the clients based on backups and exclude policy-based clients. If this flag is set to 0, the utility finds the clients that are backed up by the master server and also clients that are in the policy that is controlled by the master server.