XML Parameters for Security Associations

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.

associationsOperationType

The operation to perform on the role, users, and user groups inside the <associations> block. The entity, role, users, and user groups form a security association. To perform an operation on multiple security associations, add an <associations> block in the XML file for each security association. Within the block, use one role and any combination of user names and user group names, for example:

<associations>
   <properties>
     <role>
       <roleName></roleName>
     </role>
   </properties>
   <userOrGroup>
     <userName></userName>
   </userOrGroup>
 </associations>
 <associations>
   <properties>
     <role>
       <roleName></roleName>
     </role>
   </properties>
   <userOrGroup>
     <userName></userName>
   </userOrGroup>
   <userOrGroup>
     <userGroupName></userGroupName>
   </userOrGroup>
 </associations>
 <associations>
   <properties>
     <role>
       <roleName></roleName>
     </role>
   </properties>
   <userOrGroup>
     <externalGroupName></externalGroupName>
     <providerDomainName></providerDomainName>
   </userOrGroup>
 </associations>

Valid values are:

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

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

• DELETE, to delete one or more security associations

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>

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:

userName

The name of the user to include in the security association. To include more than one user, add <userOrGroup> and <userName> elements for each user:

<userOrGroup>
  <userName></userName>
</userOrGroup>

userGroupName

The name of the user to include in the security association. To include more than one user, add <userOrGroup> and <userName> elements for each user:

<userOrGroup>
  <userName></userName>
</userOrGroup>

externalGroupName

The name of the external user group to include in the security association. The <externalGroupName> element must be used with the <providerDomainName> element.

Example: Creating a security association that includes an external user group:

<associations>
  <properties>
    <role>
      <roleName>role001</roleName>
    </role>
  </properties>
  <userOrGroup>
    <externalGroupName>Sales</externalGroupName>
    <providerDomainName>mycompany</providerDomainName>
  </userOrGroup>
</associations>

providerDomainName

The domain name of the external user group included in the security association. The<providerDomainName> element must be used with the <externalGroupName> element.