This utility enables you to move or link large quantities of clients to different host groups. This tool accepts wildcards for the client_name_mask attribute. This utility will first validate the existence or the two group names passed as the first two parameters (see below). If the groups do not exist, the utility return an error.

Where:

source_host_group is the full pathname to the source host group, for example /Aptare/Masters/GroupA

destination_host_group is the full pathname to the destination host group.

client_name_mask is a string that can contain wildcards (*). For example, abc* indicates all clients that have an internal_name that starts with abc. To process all clients use the value NULL (which should not be within quotes).

move_or_copy_flag is 0=copy and 1=move.

This groupClientsbyAttributes utility enables you to organize clients within a host group, based on client attributes. This utility will create host groups named for each attribute value, underneath a parent host group, as shown in the following example.

Create a host group named Geography. This will be the destination group that will be used to organize the clients by location.

Then, create an attribute named Geography.

For a subset of a host group’s clients, set their Geography attribute value to London and for another subset of clients, set their Geography attribute to New York.

Use the following groupClientsbyAttributes utility to organize the clients that have a Geography attribute configured.

execute server_mgmt_pkg.groupClientsbyAttributes(300000, 302398, 1, StringObjectListType(stringObjectType('Geography')));

Where 300000 is the group ID of the root group, Global; 302398 is the ID of the Geography group you just created.

 

Additional References:

See Identifying a Host Group ID.

Where:

source_Group_ID is the numeric identifier of the host group for which you want to group the clients. See Identifying a Host Group ID for the steps for finding a group ID.

destination_group_ID is the numeric identifier of the group under which you want to group the clients.

cascade_Source_Group is a numeric flag that indicates if you want this utility to process the source host group’s sub-groups and organize those clients in the destination group.

attribute_List is a comma-separated list of attribute names, each enclosed in straight single quotes. These names are used to create the sub-groups that organize the clients underneath the source group.

This utility enables you to move a host group and all of its hierarchical contents to another host group.

Where:

source_host_group is the full pathname to the source host group, for example /Aptare/Masters/GroupA. Be sure to use the host group name, not the host group ID.

destination_host_group is the full pathname to the destination host group. Be sure to use the host group name, not the host group ID.

There are some occasions where you may wish to remove the entire contents of a host group, including any sub-groups within this group and any clients under the hierarchy. This utility allows administrators to perform this type of delete operation.

 

CAUTION: IF YOU USE THIS COMMAND TO REMOVE A HOST GROUP, AND IF CLIENTS UNDER THE HOST GROUP HIERARCHY DO NOT EXIST IN ANY OTHER GROUP, THE CLIENTS AND ALL OF THEIR ASSOCIATED CONFIGURATIONS WILL BE PERMANENTLY REMOVED FROM THE DATABASE.

Where:

parent_group_id is the group id of the parent group which contains the group to be deleted.

group_to_remove_id is the group id of the group to be deleted.

Prior versions of APTARE IT Analytics automatically created several server/host groups during backup data collection. In certain environments, these auto-generated groups may not be needed, as other host groups are more relevant. This utility can be used to clean up a Portal’s host groups by moving servers/hosts and child host groups from a host group and then deleting the source host group. While this utility, by default, is intended for system-created host groups, it can be used for any host group that you want to delete, but retain its contents.

Best Practice: In multi-tenancy environments, run this command on a domain-by-domain basis, starting from the bottom of the domain hierarchy to the top APTARE IT Analytics domain. This ensures that each domain has been explicitly processed with log messages that confirm the actions taken.

CAUTION: THIS COMMAND MOVES CLIENTS TO THE DOMAIN’S HOME HOST GROUP AND THEN PERMANENTLY REMOVES THE SPECIFIED HOST GROUPS FROM THE DATABASE. RUN THIS COMMAND IN VALIDATE MODE FIRST TO VERIFY THAT THE ACTIONS REPRESENT THE INTENDED RESULTS.

server_mgmt_pkg.serverGroupCleanup(<processingMode>, '<domain_name>', (<server_group_names_list>), '<log_file_path_name>', '<log_file_name>');

Where:

processing_mode is either 1 = Validate or 2 = Execute. Run this command in Validate mode first to understand what hosts will be moved and what host groups will be deleted.

domain_name, enclosed in single straight quotes, is the case-insensitive name of the APTARE IT Analytics domain for the group to be deleted. See the Best Practice listed above.

server_group_names_list is a comma-separated list of host group names to remove, in single straight quotes. This list must be enclosed in parentheses and prefaced with stringListType. If NULL is specified, the utility will process these system-created host groups: NetBackup Policy Types, NetBackup Policies, Inactive Policy Clients, and Policy Domains.

log_file_path_name, enclosed in single straight quotes, is the location of the log file for this process.

log_file_name, enclosed in single straight quotes, is the name of the log file.

Example of Validate Mode:

Example of Execute Mode:

Example of Validate without a list of Host Group Names:

This utility enables you to create a hierarchy of servers and links all clients that are members of a server into the respective host group.

For example, in an IBM Tivoli Storage Manager environment if you have two IBM Tivoli Storage Manager servers called TSM1, TSM2, this utility creates two host groups, TSM1 and TSM2, and links the IBM Tivoli Storage Manager server’s clients into the corresponding IBM Tivoli Storage Manager host group.

 

Example:

Where:

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

destination_group_id is the group ID in which host groups by management server will be created. Create a host group under source_group_id called <vendor_name> 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 server, if a host group exists anywhere under the source group hierarchy with the name of that 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 folder, the routine creates a host group under the source_group_id called Master Servers.

move_or_copy_flag can be set to 0=Link (copy) clients or 1=Move clients. If set to 0, the utility links the clients to their respective host groups and keeps the clients in their original group location. If set to 1, the utility moves all clients from the source host group and to their respective host groups.

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

latest_server_only, when set to 1, indicates the last server to back up the client; otherwise, set this flag to 0.

Under certain circumstances, backup clients may have duplicate entries in the APTARE IT Analytics database. This utility enables you to merge the data of clients that appear more than once in the database.

In most cases, it is not necessary to shut down the data receiver while the client records are being merged. Although not required, it is recommended that you shut down the data receiver before executing this utility so that data will not continue to be collected for the hosts that are being merged.

Merging of NetBackup master servers is not supported.

 

Example:

 

Where:

host_grp is the explicit host group path and name.

host_name_type indicates whether to use only the host’s base name while finding duplicates, or use the fully qualified name. 0 = fully qualified host name, 1 = host base name.

 

Example of a host base name: QAhost1

Example of a fully qualified host name: QAhost1.yourcompany.com