Merge pull request #1844 from jrw972/monterey
[ACE_TAO.git] / TAO / utils / nsgroup / README
blobbf0a4b471e37e00f044354f19fb667d7ff0fba6b
3 This utility provides a command line interface for the tao_ft_naming service.
4 tao_ft_naming service supports the NameService and NamingManager interfaces.
6 Here is a summary of the commands and options:
8 tao_nsgroup group_create  -group <group> -policy <round>
9 tao_nsgroup group_remove  -group <group>
10 tao_nsgroup group_bind    -group <group> -name <name>
11 tao_nsgroup group_unbind  -name <name>
12 tao_nsgroup group_list
13 tao_nsgroup member_add    -group <group> -location <location> -ior <ior>
14 tao_nsgroup member_remove -group <group> -location <location>
15 tao_nsgroup member_show   -group <group> -location <location>
16 tao_nsgroup member_list   -group <group>
17 tao_nsgroup -help
19 tao_nsgroup group_create -group <group> -policy <round>
21   Adds the object group to to the load balancing naming manager service with the
22   specified selection policy. On Creation, an object group contains no member
23   objects. Returns error if <group> is not unique. Currently the only load
24   balancing policy supported is round-robin.
26   Returns Success(0), Error(1)
28   Example:
29   $ACE_ROOT/bin/tao_nsgroup group_create -group ieee -policy round \
30     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
32 tao_nsgroup group_remove -group <group>
34   Removes the specified object group from the load balancing naming manager
35   service.
37   Returns Success(0), Error(1)
39   Example:
40   $ACE_ROOT/bin/tao_nsgroup group_remove -group ieee \
41     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
43   Note: If the object group is bound with group_bind, you must also unbind it
44   with group_unbind.
46 tao_nsgroup group_bind -group <group> -name <name>
48   Binds the specified object group to the specified stringified name in the
49   naming service. When clients resolve that name, they tranparently obtain a
50   member of the specified object group from the load balancing naming manager
51   service.
53   Returns Success(0), Error(1)
55   Example:
57   $ACE_ROOT/bin/tao_nsgroup group_bind -group ieee -name iso/ieee \
58     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
60   Note: The iso context used in this example must be created before calling
61   group_bind.
63 tao_nsgroup group_unbind -name <name>
65   Unbinds the specified stringified name from the naming service, but does not
66   remove the object group.
68   Returns Success(0), Error(1)
70   Example:
72   $ACE_ROOT/bin/tao_nsgroup group_unbind -name iso/ieee \
73     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
75 tao_nsgroup group_list
77   Displays all object groups that currently exist in the load balancing naming
78   manager service by selection policy.
80   Returns Success(0), Error(1)
82   Example:
83   $ACE_ROOT/bin/tao_nsgroup group_list \
84     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
86   Round Robin Load Balancing Groups:
87     ieee
90 tao_nsgroup member_add -group <group> -location <location> -ior <ior>
92   Adds an member object to the specified object group. After being added, the
93   member object is available for selection. Returns error if the ior is not
94   unique for the specified object group.
96   Returns Success(0), Error(1)
98   Example:
99   $ACE_ROOT/bin/tao_nsgroup member_add -group ieee -location 127.0.0.1 \
100     -ior file://mo.ior -ORBInitRef NameService=file://ns.ior \
101     -ORBInitRef NamingManager=file://nm.ior
103 tao_nsgroup member_remove -group <group> -location <location>
105   Removes the specified member object location from the specified object group.
107   Returns Success(0), Error(1)
109   Example:
110   $ACE_ROOT/bin/tao_nsgroup member_remove -group ieee -location 127.0.0.1 \
111     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
113 tao_nsgroup member_list -group <group>
115   Lists the member locations of the specified object group.
117   Returns Success(0), Error(1)
119   Example:
120   $ACE_ROOT/bin/tao_nsgroup member_list -group ieee \
121     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
122   127.0.0.1
125 tao_nsgroup member_show -group <group> -location <location>
127   Displays the object reference that cooresponds to the specified member location
128   of an object group.
130   Returns Success(0), Error(1)
132   Example:
134   $ACE_ROOT/bin/tao_nsgroup member_show -group ieee -location 127.0.0.1 \
135     -ORBInitRef NameService=file://ns.ior -ORBInitRef NamingManager=file://nm.ior
136   IOR:010000002100000049444c3a6f6d672e6f72672f46542f4e616d696e674d616e616765723a312e300000000001000000000000006c000000010102000e00000031302e3230312e3230302e363400e1841b00000014010f005253541571a65076c60a000000000001000000010000000002000000000000000800000001000000004f41540100000018000000010000000100010001000000010001050901010000000000