1
1
rpda
2
2
====
3
- is a RecoverPoint Direct Access utility to enable _ direct access _ to the latest image on a copy node
4
- within a consistency group remotely via API.
3
+ Is a RecoverPoint Direct Access utility to provide clients a simple CLI to manage _ direct access _ testing
4
+ on the latest image of a copy node within a consistency group remotely via API.
5
5
The project is written in Go (golang) and can be compiled to a single binary for ease of deployment.
6
6
7
- Download latest compiled ` x86_64 ` release binary [ here] ( https://github.com/bcambl/rpda/releases )
7
+ Download latest compiled ` x86_64 ` release binary [ here] ( https://github.com/bcambl/rpda/releases/latest )
8
8
9
9
## Configuration
10
- A configuration template will be generated upon first execution of ` rpda ` .
10
+ A configuration template will be generated upon first execution of ` rpda [command] ` .
11
11
12
12
```
13
13
api:
@@ -23,8 +23,8 @@ identifiers:
23
23
```
24
24
25
25
Update the configuration file with variables that suit your site or environment.
26
- The ` identifiers ` section in the configuration file uses [ _ regexp_ ] ( https://golang.org/pkg/regexp/ ) to determine the desired copy
27
- for when ` --test ` or ` --dr ` are used.
26
+ The ` identifiers ` section in the configuration file uses [ _ regexp_ ] ( https://golang.org/pkg/regexp/ ) to
27
+ determine the desired copy for when ` --test ` or ` --dr ` are used.
28
28
29
29
The following example will work with the default ` identifiers ` section in the configuration example above.
30
30
@@ -45,7 +45,8 @@ EXAMPLE_CONSISTENCY_GROUP_CG:
45
45
46
46
## User Permissions
47
47
An account on the RecoverPoint Appliance is required and the user must have access to administrate desired consistency groups.
48
- When issuing the ` --all ` option will only administer consistency groups of which the account has access to modify as per RecoverPoint user privledges.
48
+ This utility will only administer consistency groups of which the account has access to modify as per RecoverPoint user
49
+ privledges when ` --all ` is used.
49
50
50
51
## Specifying a Copy
51
52
Naming consistency groups using a consistent _ naming scheme_ will allow the use of ` --test ` and ` --dr ` options by
@@ -62,10 +63,17 @@ One of the following _copy flags_ must be provided:
62
63
63
64
## Additional Flags
64
65
65
- - ` --user <username> ` will override the ` username ` specified within the configuration file.
66
+ - ` --user <username> ` will override the ` username ` specified within the configuration file. _ (will prompt for password) _
66
67
- ` --delay 60 ` : will introduce a delay of ` 60 ` seconds between consistency group changes when using ` --all ` (default: ` 0 ` )
67
68
- ` --debug ` : will produce additional debugging output to assist with troubleshooting & development
68
69
- ` --check ` : will run allow the application to execute _ without_ making any changes (` GET ` requests only)
70
+ - ` --help ` : will display CLI help and examples
71
+
72
+ Note:
73
+ Each _ command_ also has its own ` --help `
74
+ ```
75
+ rpda enable --help
76
+ ```
69
77
70
78
## Command-Line Examples
71
79
@@ -92,7 +100,7 @@ Enable Direct Image Access Mode for the **_Test_ Copy** on **_ALL_** Consistency
92
100
rpda enable --all --test
93
101
```
94
102
95
- Enable Direct Image Access Mode for the ** _ Test_ Copy** on ** _ ALL_ ** Consistency Groups with ` 30 ` second delay
103
+ Enable Direct Image Access Mode for the ** _ Test_ Copy** on ** _ ALL_ ** Consistency Groups with ` 30 ` second ** delay**
96
104
```
97
105
rpda enable --all --test --delay 30
98
106
```
@@ -112,7 +120,7 @@ Enable Direct Image Access Mode for the **_DR_ Copy** on Consistency Group `Test
112
120
rpda enable --group TestGroup_CG --dr
113
121
```
114
122
115
- Enable Direct Image Access Mode for a ** _ User Defined Copy_ ** (_ Example_CN_ ) on Consistency Group ` TestGroup_CG `
123
+ Enable Direct Image Access Mode for a ** _ User Defined Copy_ ** (` _Example_CN_ ` ) on Consistency Group ` TestGroup_CG `
116
124
```
117
125
rpda enable --group TestGroup_CG --copy Example_CN
118
126
```
@@ -143,14 +151,14 @@ Finish Direct Image Access Mode on Consistency Group `TestGroup_CG` for **_DR_ C
143
151
rpda finish --group TestGroup_CG --dr
144
152
```
145
153
146
- Finish Direct Image Access Mode on Consistency Group ` TestGroup_CG ` for ** _ User Defined Copy_ ** (_ Example_CN_ )
154
+ Finish Direct Image Access Mode on Consistency Group ` TestGroup_CG ` for ** _ User Defined Copy_ ** (` _Example_CN_ ` )
147
155
```
148
156
rpda finish --group TestGroup_CG --copy Example_CN
149
157
```
150
158
151
159
## Build Instructions
152
160
153
- Download latest compiled ` x86_64/amd64 ` release binary [ here] ( https://github.com/bcambl/rpda/releases )
161
+ Download latest compiled ` x86_64/amd64 ` release binary [ here] ( https://github.com/bcambl/rpda/releases/latest )
154
162
155
163
If you would like to compile the project from source, please install the latest version of the
156
164
Go programming [ here] ( https://golang.org/dl/ ) .
@@ -165,4 +173,4 @@ Build Project for `x86_64/amd64` Windows
165
173
GOOS=windows GOARCH=amd64 go build -ldflags="-s -w" -o rpda.exe main.go
166
174
```
167
175
168
- Please read more about building the project for other platforms ($GOOS and $GOARCH) [ here] ( https://golang.org/doc/install/source#environment ) .
176
+ Please read more about building the project for other platforms (` $GOOS ` and ` $GOARCH ` ) [ here] ( https://golang.org/doc/install/source#environment ) .
0 commit comments