XML Parameters for User Operations

userName

Name of the user.

newName

If you are changing the name of the user, enter the new name in the newName parameter and the original name in the userName parameter.

associationsOperationType

The operation to perform on the role and entities inside the <associations> block. The entity, role, and user form a security association. To perform an operation on multiple security associations, add an <associations> block in the XML file for each security association:

 
<associations>
   <entities>
     <entity>
       <entity_name></entity_name>
     </entity>
   </entities>
   <properties>
     <role>
       <roleName></roleName>
     </role>
   </properties>
</associations>

Valid values are:

• ADD, to create a new security association between the entity, role, and user

• OVERWRITE, to overwrite existing security associations with new security associations

• DELETE, to delete one or more security associations

entity/entity_name

Replace entity_name with the name of the entity operated on by the associationsOperationType parameter.

Valid replacement values are:

• clientGroupName

• clientName

• appName

• backupsetName

• subclientName

• userName

• userGroupName

• providerDomainName

• mediaAgentName

• libraryName

• containerName

• locationName

• shelfName

• storagePolicyName

• schedulePolicyName

• trackingPolicyName

  To include multiple entities in a security association, add the following elements in the XML file for each entity:

   
  <entity>
    <entity_name>entity_value</entity_name>
  </entity>

  Examples

  To associate two libraries, enter the following in the XML file:

  <entities>  <entity>
      <libraryName>library_001</libraryName>
    </entity>
    <entity>
      <libraryName>library_022</libraryName>  </entity>
  </entities>

  To associate a domain, enter the following in the XML file:

  <entities>
    <entity>  <providerDomainName>mydomain</providerDomainName>
    </entity>
   </entities>

  To associate a file system and a MySQL agent, enter the following in the XML file:

  <entities>
    <entity>
     <appName>File System</appName>
    </entity>
  </entities>
  <entities>
    <entity>
     <appName>MySQL</appName>  </entity>
  </entities>

  Tip: For a list of valid values for the <appName> element, see GET Agent: appName.

role/roleName

The name of the role operated on by the associationsOperationType parameter. The <associations> block must have exactly one role, for example:

<associations>
  <properties>
   <role>
     <roleName>Role3</roleName>
   </role>
  </properties>
 ...
 ...
</associations>

associatedUserGroupsOperationType

The operation to perform on the user group in the userGroupName parameter.

Valid values are:

• ADD, to associate new user groups.

• OVERWRITE, to overwrite the existing user groups with new user groups.

• DELETE, to delete one or more user groups.

permissionName

Use this element to add permissions without selecting a role. If you use the permissionName parameter, you cannot use the roleName parameter.

The name of the permission operated on by the associationsOperationType parameter. To work with multiple permissions, add the following elements in the XML file for each permission:

<categoriesPermissionList permissionName = ""/>

For a list of valid values, see User Security Permissions and Permitted Actions.

categoryName

Use this element to add all of the permissions in a category without selecting a role. If you use the categoryName parameter, you cannot use the roleName parameter.

The name of the permission category operated on by the associationsOperationType parameter. To work with multiple categories, add the following elements in the XML file for each category:

<categoriesPermissionList categoryName = ""/>

Valid values are:

enableUser

Option to enable/disable the user.

Valid values are True/False.

agePasswordDays

Number of days to keep the password active.

email

Email address of the user.

password

A plain text password to access the user account. The password must meet any strength requirements that were set. For information, see Setting Strength Requirements for User Passwords.

To change this password, the password of the logged on user must be included in the validationParameters\password parameter.

fullName

Full name of the user.

validationParameters/password

If the password in the password parameter is changed, the password of the logged on user must be included in the validationParameters\password parameter.

description

A general description of the user account.

associatedUserGroups/userGroupName

The name of the user group operated on by the associatedUserGroupsOperationType parameter. To work with more than one user group, add the following line in the XML file for each user group:

 
<userGroupName>user_group</userGroupName>

transferAllFromOldUser

When a user is deleted, you must transfer the ownership of entities such as alerts, scheduled policies, and workflows from the deleted user to another user or user group.

To transfer ownership, the valid value is 1.

newUser/userName

The user name to transfer ownership to. When you delete a user , you must provide either a new user name or a new user group name.

newUserGroup/userGroupName

The user group name to transfer ownership to. When you delete a user , you must provide either a new user name or a new user group name.