@@ -16,10 +16,7 @@ Generate Geo-replication SSH Keys
1616
1717## create
1818``` python
19- create(volname,
20- slave_host,
21- slave_vol,
22- slave_user = ' root' ,
19+ create(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' ,
2320 push_pem = True ,
2421 no_verify = False ,
2522 force = False ,
@@ -28,12 +25,12 @@ create(volname,
2825
2926Create Geo-replication Session
3027
31- : param volname: Master Volume Name
32- : param slave_host: Slave Hostname or IP
33- : param slave_vol: Slave Volume
34- : param slave_user: Slave User, default is "root"
35- : param push_pem: True|False Push SSH keys to Slave
36- : param no_verify: True|False Skip the Slave Verification
28+ : param primary_volume: Primary Volume Name
29+ : param secondary_host: Secondary Hostname or IP
30+ : param secondary_volume: Secondary Volume
31+ : param secondary_user: Secondary User, default is "root"
32+ : param push_pem: True|False Push SSH keys to Secondary
33+ : param no_verify: True|False Skip the Secondary Verification
3734 process before create
3835: param force: True|False Force Create Session
3936: param ssh_port: SSH Port, Default is 22
@@ -43,120 +40,115 @@ Create Geo-replication Session
4340
4441## start
4542``` python
46- start(volname, slave_host, slave_vol, slave_user = ' root' , force = False )
43+ start(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' , force = False )
4744```
4845
4946Start Geo-replication Session
5047
51- : param volname: Master Volume Name
52- : param slave_host: Slave Hostname or IP
53- : param slave_vol: Slave Volume
54- : param slave_user: Slave User, default is "root"
48+ : param primary_volume: Primary Volume Name
49+ : param secondary_host: Secondary Hostname or IP
50+ : param secondary_volume: Secondary Volume
51+ : param secondary_user: Secondary User, default is "root"
5552: param force: True|False Force Start the Session
5653:returns: Output of Start command, raises
5754 GlusterCmdException((rc, out, err)) on error
5855
5956
6057## stop
6158``` python
62- stop(volname, slave_host, slave_vol, slave_user = ' root' , force = False )
59+ stop(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' , force = False )
6360```
6461
6562Stop Geo-replication Session
6663
67- : param volname: Master Volume Name
68- : param slave_host: Slave Hostname or IP
69- : param slave_vol: Slave Volume
70- : param slave_user: Slave User, default is "root"
64+ : param primary_volume: Primary Volume Name
65+ : param secondary_host: Secondary Hostname or IP
66+ : param secondary_volume: Secondary Volume
67+ : param secondary_user: Secondary User, default is "root"
7168: param force: True|False Force Stop the Session
7269:returns: Output of Stop command, raises
7370 GlusterCmdException((rc, out, err)) on error
7471
7572
7673## restart
7774``` python
78- restart(volname, slave_host, slave_vol, slave_user = ' root' , force = False )
75+ restart(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' , force = False )
7976```
8077
8178Restart Geo-replication Session
8279
83- : param volname: Master Volume Name
84- : param slave_host: Slave Hostname or IP
85- : param slave_vol: Slave Volume
86- : param slave_user: Slave User, default is "root"
80+ : param primary_volume: Primary Volume Name
81+ : param secondary_host: Secondary Hostname or IP
82+ : param secondary_volume: Secondary Volume
83+ : param secondary_user: Secondary User, default is "root"
8784: param force: True|False Force Start the Session
8885:returns: Output of Start command, raises
8986 GlusterCmdException((rc, out, err)) on error
9087
9188
9289## delete
9390``` python
94- delete(volname,
95- slave_host,
96- slave_vol,
97- slave_user = ' root' ,
91+ delete(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' ,
9892 reset_sync_time = None )
9993```
10094
10195Delete Geo-replication Session
10296
103- : param volname: Master Volume Name
104- : param slave_host: Slave Hostname or IP
105- : param slave_vol: Slave Volume
106- : param slave_user: Slave User, default is "root"
97+ : param primary_volume: Primary Volume Name
98+ : param secondary_host: Secondary Hostname or IP
99+ : param secondary_volume: Secondary Volume
100+ : param secondary_user: Secondary User, default is "root"
107101: param reset_sync_time: True|False Reset Sync time on delete
108102:returns: Output of Start command, raises
109103 GlusterCmdException((rc, out, err)) on error
110104
111105
112106## pause
113107``` python
114- pause(volname, slave_host, slave_vol, slave_user = ' root' , force = False )
108+ pause(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' , force = False )
115109```
116110
117111Pause Geo-replication Session
118112
119- : param volname: Master Volume Name
120- : param slave_host: Slave Hostname or IP
121- : param slave_vol: Slave Volume
122- : param slave_user: Slave User, default is "root"
113+ : param primary_volume: Primary Volume Name
114+ : param secondary_host: Secondary Hostname or IP
115+ : param secondary_volume: Secondary Volume
116+ : param secondary_user: Secondary User, default is "root"
123117: param force: True|False Force Pause Session
124118:returns: Output of Pause command, raises
125119 GlusterCmdException((rc, out, err)) on error
126120
127121
128122## resume
129123``` python
130- resume(volname, slave_host, slave_vol, slave_user = ' root' , force = False )
124+ resume(primary_volume, secondary_host, secondary_volume, secondary_user = ' root' , force = False )
131125```
132126
133127Resume Geo-replication Session
134128
135- : param volname: Master Volume Name
136- : param slave_host: Slave Hostname or IP
137- : param slave_vol: Slave Volume
138- : param slave_user: Slave User, default is "root"
129+ : param primary_volume: Primary Volume Name
130+ : param secondary_host: Secondary Hostname or IP
131+ : param secondary_volume: Secondary Volume
132+ : param secondary_user: Secondary User, default is "root"
139133: param force: True|False Force Resume Session
140134:returns: Output of Resume command, raises
141135 GlusterCmdException((rc, out, err)) on error
142136
143137
144138## config_set
145139``` python
146- config_set(volname,
147- slave_host,
148- slave_vol,
140+ config_set(primary_volume, secondary_host, secondary_volume,
149141 key,
150142 value,
151- slave_user = ' root' )
143+ secondary_user = ' root' )
152144```
153145
154146Set Config of a Geo-replication Session
155147
156- : param volname: Master Volume Name
157- : param slave_host: Slave Hostname or IP
158- : param slave_vol: Slave Volume
159- : param slave_user: Slave User, default is "root"
148+ : param primary_volume: Primary Volume Name
149+ : param secondary_host: Secondary Hostname or IP
150+ : param secondary_volume: Secondary Volume
151+ : param secondary_user: Secondary User, default is "root"
160152: param key: Config Key
161153: param value: Config Value
162154:returns: Output of Config set command, raises
@@ -165,47 +157,47 @@ Set Config of a Geo-replication Session
165157
166158## config_reset
167159``` python
168- config_reset(volname, slave_host, slave_vol , key, slave_user = ' root' )
160+ config_reset(primary_volume, secondary_host, secondary_volume , key, secondary_user = ' root' )
169161```
170162
171163Reset configuration of Geo-replication Session
172164
173- : param volname: Master Volume Name
174- : param slave_host: Slave Hostname or IP
175- : param slave_vol: Slave Volume
176- : param slave_user: Slave User, default is "root"
165+ : param primary_volume: Primary Volume Name
166+ : param secondary_host: Secondary Hostname or IP
167+ : param secondary_volume: Secondary Volume
168+ : param secondary_user: Secondary User, default is "root"
177169: param key: Config Key
178170:returns: Output of Config reset command, raises
179171 GlusterCmdException((rc, out, err)) on error
180172
181173
182174## config_get
183175``` python
184- config_get(volname, slave_host, slave_vol , key = None , slave_user = ' root' )
176+ config_get(primary_volume, secondary_host, secondary_volume , key = None , secondary_user = ' root' )
185177```
186178
187179Get Configuration of Geo-replication Session
188180
189- : param volname: Master Volume Name
190- : param slave_host: Slave Hostname or IP
191- : param slave_vol: Slave Volume
192- : param slave_user: Slave User, default is "root"
181+ : param primary_volume: Primary Volume Name
182+ : param secondary_host: Secondary Hostname or IP
183+ : param secondary_volume: Secondary Volume
184+ : param secondary_user: Secondary User, default is "root"
193185: param key: Config Key
194186:returns: Geo-rep session Config Values, raises
195187 GlusterCmdException((rc, out, err)) on error
196188
197189
198190## status
199191``` python
200- status(volname = None , slave_host = None , slave_vol = None , slave_user = ' root' )
192+ status(primary_volume = None , secondary_host = None , secondary_volume = None , secondary_user = ' root' )
201193```
202194
203195Status of Geo-replication Session
204196
205- : param volname: Master Volume Name
206- : param slave_host: Slave Hostname or IP
207- : param slave_vol: Slave Volume
208- : param slave_user: Slave User, default is "root"
197+ : param primary_volume: Primary Volume Name
198+ : param secondary_host: Secondary Hostname or IP
199+ : param secondary_volume: Secondary Volume
200+ : param secondary_user: Secondary User, default is "root"
209201:returns: Geo-replication Status, raises
210202 GlusterCmdException((rc, out, err)) on error
211203
0 commit comments