IBM Support

Supplement to the Command Reference Guide on vob_sidwalk and vob_siddump

Preventive Service Planning


Abstract

This document is meant to serve as a supplement to the IBM Rational ClearCase Command Reference Guide on the topic of vob_sidwalk and vob_siddump by providing an example on how the commands are run from Microsoft Windows, UNIX or Linux.

Content



Note: The information in this technote has been incorporated into the 8.0 version of the
IBM Rational ClearCase Knowledge Center.





UNIX/LINUX EXAMPLE

SCENARIO: A user (named John Doe) with a username of jdoe has left the company. His replacement is Bob Smith and he has a username of bobsmith. The VOB is non-replicated.


OBJECTIVE: Transfer ownership of all the objects (elements, versions, branches, labels and so on) in the VOBs John was working in to Bob.

Note: The same steps apply if a group change was made.


*************************************************************************************

1. Log in as root and create a dump file (in this example called dump_final.out) using the vob_siddump command.

Note: The vob_siddump (and vob_sidwalk) command is located in the directory <clearcase home>/etc/utils and will list all the objects in the VOB and report on which UID and GID owns those objects.

[root@unix1 /]# vob_siddump -v -log /tmp/log.out /vob/sidwalktest /tmp/dump_final.out

VOB Tag: /vob/sidwalktest (unix1:/ccstg/vobs/sidwalktest.vbs)

Meta-type "directory element" ...   17 object(s)
Meta-type "directory version" ...   36 object(s)
Meta-type "tree element" ...   0 object(s)
Meta-type "element type" ...   13 object(s)
Meta-type "file element" ...   80 object(s)
Meta-type "derived object" ...   0 object(s)
Meta-type "derived object version" ...   0 object(s)
Meta-type "version" ...   156 object(s)
Meta-type "symbolic link" ...   0 object(s)
Meta-type "hyperlink" ...   0 object(s)
Meta-type "branch" ...   97 object(s)
Meta-type "pool" ...   3 object(s)
Meta-type "branch type" ...   1 object(s)
Meta-type "attribute type" ...   3 object(s)
Meta-type "hyperlink type" ...   9 object(s)
Meta-type "trigger type" ...   0 object(s)
Meta-type "replica type" ...   1 object(s)
Meta-type "label type" ...   3 object(s)
Meta-type "replica" ...   1 object(s)
Meta-type "activity type" ...   0 object(s)
Meta-type "activity" ...   0 object(s)
Meta-type "state type" ...   0 object(s)
Meta-type "state" ...   0 object(s)
Meta-type "role" ...   0 object(s)
Meta-type "user" ...   0 object(s)
Meta-type "baseline" ...   0 object(s)
Meta-type "domain" ...   0 object(s)

Total number of objects found: 420


Successfully processed VOB "/vob/sidwalktest".

*************************************************************************************


2.  Edit the dump file (dump_final.out) with a text editor to map the names of the objects owned by the old UID/GID (jdoe) to the new UID/GID (bobsmith).

BEFORE:

[root@unix1 /]# cat /tmp/dump_final.out
jdoe,USER,UNIX:UID-1000,IGNORE,,,136
bobsmith,USER,UNIX:UID-2000,IGNORE,,,1


clearusers,GROUP,UNIX:GID-20,IGNORE,,,136
group1,GROUP,UNIX:GID-10,IGNORE,,,1
group2,GROUP,UNIX:GID-100,IGNORE,,,1
group3,GROUP,UNIX:GID-6000,IGNORE,,,2

Note: In this example output, jdoe has a UID of 1000 and owns 136 objects in the VOB while bobsmith has a UID of 2000 and owns 1 object in the VOB. There are 4 groups reported as owning objects in this VOB. Group named clearusers has a GID of 20 and owns 136 objects. The other groups (group1, group 2 and group3) own objects as well.


[root@unix1 /]# vi /tmp/dump_final.out
(Open text editor to modify map file)


AFTER:

[root@unix1 /]# cat /tmp/dump_final.out
jdoe,USER,UNIX:UID-1000,bobsmith,USER,UNIX:UID-2000,136
bobsmith,USER,UNIX:UID-2000,IGNORE,,,1


clearusers,GROUP,UNIX:GID-20,IGNORE,,,136
group1,GROUP,UNIX:GID-10,IGNORE,,,1
group2,GROUP,UNIX:GID-100,IGNORE,,,1
group3,GROUP,UNIX:GID-6000,IGNORE,,,2


Note: In this example output, the line where jdoe reports owning 136 objects was modified. The word IGNORE was replaced with the new name bobsmith. The jdoe line could also be entered in the following format eliminating the arguments past the user name on that line which will pick up the proper UID and number of objects when referenced: jdoe,USER,UNIX:UID-1000,bobsmith
*************************************************************************************


3.  Test the dump file.


  • First run vob_sidwalk without the execute option:

[root@unix1 /]# vob_sidwalk -v -m /tmp/dump_final.out /vob/sidwalktest /tmp/test_out.log

VOB Tag: /vob/sidwalktest (unix1:/ccstg/vobs/sidwalktest.vbs)

Meta-type "directory element" ...   17 object(s)
Meta-type "directory version" ...   36 object(s)
Meta-type "tree element" ...   0 object(s)
Meta-type "element type" ...   13 object(s)
Meta-type "file element" ...   80 object(s)
Meta-type "derived object" ...   0 object(s)
Meta-type "derived object version" ...   0 object(s)
Meta-type "version" ...   156 object(s)
Meta-type "symbolic link" ...   0 object(s)
Meta-type "hyperlink" ...   0 object(s)
Meta-type "branch" ...   97 object(s)
Meta-type "pool" ...   3 object(s)
Meta-type "branch type" ...   1 object(s)
Meta-type "attribute type" ...   3 object(s)
Meta-type "hyperlink type" ...   9 object(s)
Meta-type "trigger type" ...   0 object(s)
Meta-type "replica type" ...   1 object(s)
Meta-type "label type" ...   3 object(s)
Meta-type "replica" ...   1 object(s)
Meta-type "activity type" ...   0 object(s)
Meta-type "activity" ...   0 object(s)
Meta-type "state type" ...   0 object(s)
Meta-type "state" ...   0 object(s)
Meta-type "role" ...   0 object(s)
Meta-type "user" ...   0 object(s)
Meta-type "baseline" ...   0 object(s)
Meta-type "domain" ...   0 object(s)

Total number of objects found: 420


Successfully processed VOB "/vob/sidwalktest".

  • Then check the new output file (test_out.log) to see if the new UID/GID (bobsmith) is incorporated in the output file as follows:
[root@unix1 /]# cat /tmp/test_out.log
jdoe,USER,UNIX:UID-1000,bobsmith,USER,UNIX:UID-2000,136    
<=== **
bobsmith,USER,UNIX:UID-2000,IGNORE,,,1  


clearusers,GROUP,UNIX:GID-20,IGNORE,,,136
group1,GROUP,UNIX:GID-10,IGNORE,,,1
group2,GROUP,UNIX:GID-100,IGNORE,,,1
group3,GROUP,UNIX:GID-6000,IGNORE,,,2


Note: As you can see above, the output shows that the user (bobsmith) was correctly mapped over and the UID was filled in correctly.
*************************************************************************************


4.  Apply the changes in the VOB by running vob_sidwalk with the execute option:

[root@unix1 /]# vob_sidwalk -v -m /tmp/dump_final.out -execute /vob/sidwalktest /tmp/test_out_final.log

VOB Tag: /vob/sidwalktest (unix1:/ccstg/vobs/sidwalktest.vbs)

Meta-type "directory element" ...   17 object(s)
Meta-type "directory version" ...   36 object(s)
Meta-type "tree element" ...   0 object(s)
Meta-type "element type" ...   13 object(s)
Meta-type "file element" ...   80 object(s)
Meta-type "derived object" ...   0 object(s)
Meta-type "derived object version" ...   0 object(s)
Meta-type "version" ...   156 object(s)
Meta-type "symbolic link" ...   0 object(s)
Meta-type "hyperlink" ...   0 object(s)
Meta-type "branch" ...   97 object(s)
Meta-type "pool" ...   3 object(s)
Meta-type "branch type" ...   1 object(s)
Meta-type "attribute type" ...   3 object(s)
Meta-type "hyperlink type" ...   9 object(s)
Meta-type "trigger type" ...   0 object(s)
Meta-type "replica type" ...   1 object(s)
Meta-type "label type" ...   3 object(s)
Meta-type "replica" ...   1 object(s)
Meta-type "activity type" ...   0 object(s)
Meta-type "activity" ...   0 object(s)
Meta-type "state type" ...   0 object(s)
Meta-type "state" ...   0 object(s)
Meta-type "role" ...   0 object(s)
Meta-type "user" ...   0 object(s)
Meta-type "baseline" ...   0 object(s)
Meta-type "domain" ...   0 object(s)

Total number of objects found: 420


Successfully processed VOB "/vob/sidwalktest".

*************************************************************************************


5.  Verify the success of the reprotection by running vob_siddump and checking the output file.

[root@unix1 /]# vob_siddump -v -log /tmp/log.out /vob/sidwalktest /tmp/dump_final_check.out

VOB Tag: /vob/sidwalktest (unix1:/ccstg/vobs/sidwalktest.vbs)

Meta-type "directory element" ...   17 object(s)
Meta-type "directory version" ...   36 object(s)
Meta-type "tree element" ...   0 object(s)
Meta-type "element type" ...   13 object(s)
Meta-type "file element" ...   80 object(s)
Meta-type "derived object" ...   0 object(s)
Meta-type "derived object version" ...   0 object(s)
Meta-type "version" ...   156 object(s)
Meta-type "symbolic link" ...   0 object(s)
Meta-type "hyperlink" ...   0 object(s)
Meta-type "branch" ...   97 object(s)
Meta-type "pool" ...   3 object(s)
Meta-type "branch type" ...   1 object(s)
Meta-type "attribute type" ...   3 object(s)
Meta-type "hyperlink type" ...   9 object(s)
Meta-type "trigger type" ...   0 object(s)
Meta-type "replica type" ...   1 object(s)
Meta-type "label type" ...   3 object(s)
Meta-type "replica" ...   1 object(s)
Meta-type "activity type" ...   0 object(s)
Meta-type "activity" ...   0 object(s)
Meta-type "state type" ...   0 object(s)
Meta-type "state" ...   0 object(s)
Meta-type "role" ...   0 object(s)
Meta-type "user" ...   0 object(s)
Meta-type "baseline" ...   0 object(s)
Meta-type "domain" ...   0 object(s)

Total number of objects found: 420


Successfully processed VOB "/vob/sidwalktest".



[root@unix1 /]# cat /tmp/dump_final_check.out
bobsmith,USER,UNIX:UID-2000,IGNORE,,,137

clearusers,GROUP,UNIX:GID-20,IGNORE,,,136
group1,GROUP,UNIX:GID-10,IGNORE,,,1
group2,GROUP,UNIX:GID-100,IGNORE,,,1
group3,GROUP,UNIX:GID-6000,IGNORE,,,2


Note: You can see there are now 137 objects owned by bobsmith.



WINDOWS EXAMPLE

SCENARIO: A user (named John Doe) with a username of jdoe has left the company. His replacement is Bob Smith and he has a username of bobsmith. Also, all the objects in the VOB (which is replicated as and identity-preserving replica) are owned by the Windows group Domain Users. You want to use a different Windows group (users) to tighten security on your VOBs.

OBJECTIVE: Transfer ownership of all the objects (elements, versions, branches, labels and so on) in the VOBs John was working in to Bob as well as change the group ownership from Domain Users to users..

Note: The same steps apply if a group change was made.

1. Obtain the Security ID (SID) of the users and or groups to complete the preceding steps using the creds command.


Example:


C:>creds bobsmith
Login name:       DOMAIN\bobsmith
USID:             NT:S-1-5-21-141845252-1443263951-584457872-1644
Primary group: DOMAIN\clearuser (NT:S-1-5-21-141845252-1443263951-584457872-1023)
Groups: (11)
Everyone (NT:S-1-1-0)
BUILTIN\Administrators (NT:S-1-5-32-544)
BUILTIN\Users (NT:S-1-5-32-545)
DOMAIN\Domain Users (NT:S-1-5-21-141845252-1443263951-584457872-513)
DOMAIN\Domain Admins (NT:S-1-5-21-141845252-1443263951-584457872-512)
DOMAIN\clearcase (NT:S-1-5-21-141845252-1443263951-584457872-1022)
DOMAIN\users (NT:S-1-5-21-141845252-1443263951-584457872-1199)
LOCAL (NT:S-1-2-0)
NT AUTHORITY\INTERACTIVE (NT:S-1-5-4)
NT AUTHORITY\Authenticated Users (NT:S-1-5-11)

You have ClearCase administrative privileges.

C:>creds jdoe
Login name:       DOMAIN\jdoe
USID:             NT:
S-1-5-21-141845252-1443263951-584457872-2038
Primary group: DOMAIN\Domain Users (NT:S-1-5-21-141845252-1443263951-584457872-513)
Groups: (10)
Everyone (NT:S-1-1-0)
BUILTIN\Administrators (NT:S-1-5-32-544)
BUILTIN\Users (NT:S-1-5-32-545)
DOMAIN\Domain Admins (NT:S-1-5-21-141845252-1443263951-584457872-512)
DOMAIN\users (NT:S-1-5-21-141845252-1443263951-584457872-1199)
LOCAL (NT:S-1-2-0)
NT AUTHORITY\INTERACTIVE (NT:S-1-5-4)
NT AUTHORITY\Authenticated Users (NT:S-1-5-11)

You do not have ClearCase administrative privileges.

Note: C:\Program Files\Rational\ClearCase\etc\utils is in the system path on the host running the example below thus allowing the commands (such as creds) that reside in that directory to be run from the C:\ drive.
*************************************************************************************

2. Log in as VOB owner or Administrator and create a dump file (in this example called sid1) using the vob_sidwalk command.



Note: This command will list all the objects in the VOB and report on which SID (user and group) owns those objects.

C:\>vob_sidwalk \sidwalktest c:\sid1
VOB Tag: \sidwalktest (VOB_SERVER:D:\cc_storage\vobs\sidwalktest.vbs)

Meta-type "directory element" ...     6 object(s)
Meta-type "directory version" ...     15 object(s)
Meta-type "tree element" ...     0 object(s)
Meta-type "element type" ...     11 object(s)
Meta-type "file element" ...     27 object(s)
Meta-type "derived object" ...     0 object(s)
Meta-type "derived object version" ...     0 object(s)
Meta-type "version" ...     54 object(s)
Meta-type "symbolic link" ...     0 object(s)
Meta-type "hyperlink" ...     0 object(s)
Meta-type "branch" ...     33 object(s)
Meta-type "pool" ...     3 object(s)
Meta-type "branch type" ...     1 object(s)
Meta-type "attribute type" ...     3 object(s)
Meta-type "hyperlink type" ...     9 object(s)
Meta-type "trigger type" ...     0 object(s)
Meta-type "replica type" ...     1 object(s)
Meta-type "label type" ...     3 object(s)
Meta-type "replica" ...     1 object(s)
Meta-type "activity type" ...     0 object(s)
Meta-type "activity" ...     0 object(s)
Meta-type "state type" ...     0 object(s)
Meta-type "state" ...     0 object(s)
Meta-type "role" ...     0 object(s)
Meta-type "user" ...     0 object(s)
Meta-type "checkpoint" ...     0 object(s)
Meta-type "domain" ...     0 object(s)

Total number of objects found: 167


Successfully processed VOB "\sidwalktest".

*************************************************************************************

3. Edit the dump file (sid1) with a text editor to map the names of the objects owned by the old SID (jdoe) to the new SID (bobsmith).


BEFORE:


C:\>type sid1
DOMAIN\jdoe,USER,NT:S-1-5-21-141845252-1443263951-584457872-2038,IGNORE,,,65

DOMAIN\Domain Users,GROUP,NT:S-1-5-21-141845252-1443263951-584457872-513,IGNORE,,,65


Note: In this example output, there is one owner reported as owning 65 objects in this VOB. The user is jdoe and has a SID of NT:S-1-5-21-141845252-1443263951-584457872-2038.
There is one group reported as owning 65 objects in this VOB. The group is named Domain Users has a SID of NT:S-1-5-21-141845252-1443263951-584457872-513.


C:\>notepad sid1 (Open text editor to modify map file)


AFTER:


C:\>type sid1
DOMAIN\jdoe,USER,NT:S-1-5-21-141845252-1443263951-584457872-2038,^
DOMAIN\bobsmith,USER,S-1-5-21-141845252-1443263951-584457872-1644,65

DOMAIN\Domain Users,GROUP,NT:S-1-5-21-141845252-1443263951-584457872-513,^
DOMAIN\clearuser,GLOBALGROUP,S-1-5-21-141845252-1443263951-584457872-1023,65


IMPORTANT: The ^ is not part of the command. The ^ represents a continuation in the line (without spaces) where there appears to be a line break.


Note:
In this example output, the line where jdoe reports owning 65 objects was modified.
The word IGNORE was replaced with DOMAIN\bobsmith,USER,S-1-5-21-141845252-1443263951-584457872-1644.
The line where DOMAIN\Domain Users reports owning 65 objects was modified.
The word IGNORE was replaced with DOMAIN\user,GLOBALGROUP,S-1-5-21-141845252-1443263951-584457872-1023.

Refer to technote 1407811 Differences between GROUP and GLOBALGROUP in vob_sidwalk and vob_siddump for further information about the differences between GROUP and GLOBALGROUP.

HINT: Copy and paste the SID information from the creds output into the map file to avoid potential typos.
*************************************************************************************



4.  Apply the mapping in the VOB by running vob_sidwalk with the execute option:

C:\>vob_sidwalk -map c:\sid1 -execute \sidwalktest c:\sid2

VOB Tag: \sidwalktest (VOB_SERVER:D:\cc_storage\vobs\sidwalktest.vbs)

Meta-type "directory element" ...     6 object(s)
Meta-type "directory version" ...     15 object(s)
Meta-type "tree element" ...     0 object(s)
Meta-type "element type" ...     11 object(s)
Meta-type "file element" ...     27 object(s)
Meta-type "derived object" ...     0 object(s)
Meta-type "derived object version" ...     0 object(s)
Meta-type "version" ...     54 object(s)
Meta-type "symbolic link" ...     0 object(s)
Meta-type "hyperlink" ...     0 object(s)
Meta-type "branch" ...     33 object(s)
Meta-type "pool" ...     3 object(s)
Meta-type "branch type" ...     1 object(s)
Meta-type "attribute type" ...     3 object(s)
Meta-type "hyperlink type" ...     9 object(s)
Meta-type "trigger type" ...     0 object(s)
Meta-type "replica type" ...     1 object(s)
Meta-type "label type" ...     3 object(s)
Meta-type "replica" ...     1 object(s)
Meta-type "activity type" ...     0 object(s)
Meta-type "activity" ...     0 object(s)
Meta-type "state type" ...     0 object(s)
Meta-type "state" ...     0 object(s)
Meta-type "role" ...     0 object(s)
Meta-type "user" ...     0 object(s)
Meta-type "checkpoint" ...     0 object(s)
Meta-type "domain" ...     0 object(s)

Total number of objects found: 167


Successfully processed VOB "\sidwalktest".

*************************************************************************************


5. Check the new output file (sid2) to see if the new SID (user bobsmith and group clearuser) is incorporated in the output file as follows:


C:\>type sid2

DOMAIN\jdoe,USER,NT:S-1-5-21-141845252-1443263951-584457872-2038,^
DOMAIN\bobsmith,USER,NT:S-1-5-21-141845252-1443263951-584457872-1644,65

DOMAIN\Domain Users,GROUP,NT:S-1-5-21-141845252-1443263951-584457872-513,^
DOMAIN\clearuser,GLOBALGROUP,NT:S-1-5-21-141845252-1443263951-584457872-1023,65


Note: As you can see above, the output shows that the user (bobsmith) and the group (user) were correctly mapped over. In this example output, the line where jdoe reports owning 65 objects now includes DOMAIN\bobsmith,USER,S-1-5-21-141845252-1443263951-584457872-1644.
The line where DOMAIN\Domain Users reports owning 65 objects now includes DOMAIN\user,GLOBALGROUP,S-1-5-21-141845252-1443263951-584457872-1023.



*************************************************************************************

6. As the VOB in this example is an identity-preserving replica, the vob_sidwalk command will be run a second time to remove any historical SIDs found in the group list.

C:\>vob_sidwalk -delete_groups \sidwalktest c:\sid3

VOB Tag: \sidwalktest (VOB_SERVER:D:\cc_storage\vobs\sidwalktest.vbs)

Meta-type "directory element" ...     6 object(s)
Meta-type "directory version" ...     15 object(s)
Meta-type "tree element" ...     0 object(s)
Meta-type "element type" ...     11 object(s)
Meta-type "file element" ...     27 object(s)
Meta-type "derived object" ...     0 object(s)
Meta-type "derived object version" ...     0 object(s)
Meta-type "version" ...     54 object(s)
Meta-type "symbolic link" ...     0 object(s)
Meta-type "hyperlink" ...     0 object(s)
Meta-type "branch" ...     33 object(s)
Meta-type "pool" ...     3 object(s)
Meta-type "branch type" ...     1 object(s)
Meta-type "attribute type" ...     3 object(s)
Meta-type "hyperlink type" ...     9 object(s)
Meta-type "trigger type" ...     0 object(s)
Meta-type "replica type" ...     1 object(s)
Meta-type "label type" ...     3 object(s)
Meta-type "replica" ...     1 object(s)

Meta-type "activity type" ...     0 object(s)
Meta-type "activity" ...     0 object(s)
Meta-type "state type" ...     0 object(s)
Meta-type "state" ...     0 object(s)
Meta-type "role" ...     0 object(s)
Meta-type "user" ...     0 object(s)
Meta-type "checkpoint" ...     0 object(s)
Meta-type "domain" ...     0 object(s)

Total number of objects found: 167


Successfully processed VOB "\sidwalktest".

*************************************************************************************

7. Check the new output file (sid3) to see if the old SIDs (user jdoe and group Domain Users) have been removed from the VOB database.


C:\>type sid3

DOMAIN\bobsmith,USER,NT:S-1-5-21-141845252-1443263951-584457872-1644,IGNORE,,,65

DOMAIN\clearuser,GLOBALGROUP,NT:S-1-5-21-141845252-1443263951-584457872-1023,IGNORE,,,65

*************************************************************************************

8. Fix protections on the VOB storage directory after removing the old user and group.

Note:
This step would not be required if the old user and group were not removed.


C:\>vob_sidwalk -recover_filesystem \sidwalktest c:\sid4

VOB Tag: \sidwalktest (VOB_SERVER:D:\cc_storage\vobs\sidwalktest.vbs)

Meta-type "element type" ...     11 object(s)
Meta-type "file element" ...     27 object(s)
Meta-type "derived object" ...     0 object(s)
Meta-type "derived object version" ...     0 object(s)
Meta-type "version" ...     54 object(s)

Total number of objects found: 92


Successfully processed VOB "\sidwalktest".




DOCUMENTATION

[{"Product":{"code":"SSSH27","label":"Rational ClearCase"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Permissions","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"2003.06.00;2003.06.16;7.0;7.0.1;7.1","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
16 June 2018

UID

swg21256390