IBM Support

Advanced Import With XML

Question & Answer


Question

Advanced Import With XML

Answer


Title :
Advanced Import With XML
Article:
The XML file should look like the example below, the comments are for explanation reasons only, and may be removed before performing the import if desired.  

Notes:

· Leaving the <Permissions> tag empty for a folder will cause that folder to inherit permissions from its parent folder.
· Leaving the <Permissions> tag empty for a Secret will cause that Secret to inherit permissions from its folder.
· To add a line-break within a Notes field use "##BR##".
· Groups section is only supported in version 7.8.000010 and above.
Note: Please do not edit the XML file with notepad.exe, use Notepad++, Visual Studio Code, or Atom to make your edits. There is a big chance your XML file fail import if you use Notepad.exe

Sample XML:

 
<?xml version="1.0" encoding="utf-16"?> 
<ImportFile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 
<Folders>
<Folder>
<FolderName>Customers</FolderName>
<FolderPath>Customers</FolderPath>
<Permissions>
<Permission>
<View>true</View>
<Edit>true</Edit>
<Owner>true</Owner>
<UserName>admin</UserName> <!-- Either UserName or GroupName is                     required in permissions -->
</Permission>
<Permission>
<View>true</View>
<Edit>false</Edit>
<Owner>false</Owner>
<GroupName>Auditors</GroupName>
</Permission>
</Permissions>
</Folder>
<Folder>
<FolderName>Customer A</FolderName>
<FolderPath>Customers\Customer A</FolderPath>
<Permissions /> <!-- Empty Permissions will cause Folder to inherit from             parent -->
</Folder>
</Folders>
<Groups> <!-- Groups are optional and available as of version 7.8.000010 -->
<Group>
<GroupName>Other Administrators</GroupName>
<GroupMembers>
<GroupMember>
<UserName>admin2</UserName>
</GroupMember>
<GroupMember>
<UserName>DomainAdmin</UserName>
<Domain> testdomain.test.com</Domain> 
</GroupMember>
</GroupMembers>
</Group>
<Group>
<GroupName>Domain Administrators</GroupName>
<Domain> testdomain.test.com</Domain> 
<GroupMembers>
<GroupMember>
<UserName>DomainAdmin</UserName>
<Domain> testdomain.test.com</Domain> 
</GroupMember>
</GroupMembers>
</Group>
</Groups>
<SecretTemplates>
<secrettype> <!-- You can have multiple secrettype entries -->
<name>Windows Account</name>
<active>true</active>
<fields>
<field isexpirationfield="false">
<name>Resource URL</name>
<mustencrypt>false</mustencrypt>
<isurl>false</isurl>
<ispassword>false</ispassword>
<isnotes>false</isnotes>
<isfile>false</isfile>
<passwordlength>0</passwordlength>
<historylength>0</historylength>
<isindexable>false</isindexable>
</field>
<field isexpirationfield="false">
<name>Username</name>
<mustencrypt>false</mustencrypt>
<isurl>false</isurl>
<ispassword>false</ispassword>
<isnotes>false</isnotes>
<isfile>false</isfile>
<passwordlength>0</passwordlength>
<historylength>0</historylength>
<isindexable>false</isindexable>
</field>
<field isexpirationfield="false">
<name>Password</name>
<mustencrypt>true</mustencrypt>
<isurl>false</isurl>
<ispassword>true</ispassword>
<isnotes>false</isnotes>
<isfile>false</isfile>
<passwordlength>12</passwordlength>
<historylength>2147483647</historylength> <!-- Use this number for                     'All' history -->
<isindexable>false</isindexable>
</field>
                <field isexpirationfield="false"> 
<name>Notes</name>
<mustencrypt>false</mustencrypt>
<isurl>false</isurl>
<ispassword>false</ispassword>
<isnotes>true</isnotes>
<isfile>false</isfile>
<passwordlength>0</passwordlength>
<historylength>0</historylength>
<isindexable>true</isindexable>
</field>
</fields>
<expirationdays>0</expirationdays>
</secrettype>
</SecretTemplates>
<Secrets>
<Secret>
<SecretName>Test Secret</SecretName>
<SecretTemplateName>Windows Account</SecretTemplateName>
<FolderPath>Customers\Customer A</FolderPath>
<Permissions>
<Permission>
<View>true</View>
<Edit>true</Edit>
<Owner>false</Owner>
<GroupName>IT Admins</GroupName>
</Permission>
<Permission>
<View>true</View>
<Edit>true</Edit>
<Owner>true</Owner>
<UserName>admin</UserName>
</Permission>
</Permissions>
<SecretItems>
<SecretItem>
<FieldName>Resource URL</FieldName>
<Value>10.10.0.25</Value>
</SecretItem>
<SecretItem>
<FieldName>Username</FieldName>
<Value>Administrator</Value>
</SecretItem>
<SecretItem>
<FieldName>Password</FieldName>
<Value>D*KGY#$5</Value>
</SecretItem>
<SecretItem>
<FieldName>Notes</FieldName>
<Value>Just some notes##BR##...and some more notes on a new line.                </Value>
</SecretItem>
</SecretItems>
</Secret>
<Secret>
<SecretName>Another Test Secret</SecretName>
<SecretTemplateName>Windows Account</SecretTemplateName>
<FolderPath>Customers\Customer A</FolderPath>
<Permissions /><!-- Empty Permissions causes Secret to inherit from Folder -->
<SecretItems>
<SecretItem>
<FieldName>Resource URL</FieldName>
<Value>10.10.0.25</Value>
</SecretItem>
<SecretItem>
<FieldName>Username</FieldName>
<Value>JSmith</Value>
</SecretItem>
<SecretItem>
<FieldName>Password</FieldName>
<Value>DKud3()DS</Value>
</SecretItem>
<SecretItem>
<FieldName>Notes</FieldName>
<Value>This line has an empty line##BR####BR##in between this line.</Value>
</SecretItem>
</SecretItems>
<SecretDependencies> <!-- Secret Dependencies are optional -->
<SecretDependency> <!-- There can be more than one Secret Dependencies -->
<Active>true</Active>
<Restart>true</Restart>
<Description>Some Dependency</Description>
<MachineName>192.168.99.1</MachineName>
<DependencyName>Some Service</DependencyName>
<Type>Windows Service</Type>
<PrivilegedAccount>Some Account</PrivilegedAccount> <!-- Leave this blank to not use a PrivilegedAccount -->
<WaitBeforeSeconds>10</WaitBeforeSeconds>
</SecretDependency>
</SecretDependencies>
</Secret>
</Secrets>
</ImportFile>

[{"Product":{"code":"SSWHLP","label":"IBM Security Secret Server"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"--","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"10.4","Edition":"","Line of Business":{"code":"LOB24","label":"Security Software"}}]

Document Information

Modified date:
17 June 2018

UID

swg22016900