You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _migration-assistant/migration-console/migration-console-commands-references.md
+69-10Lines changed: 69 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,58 @@ console clusters cat-indices
36
36
```
37
37
{% include copy.html %}
38
38
39
+
### Execute HTTP requests against clusters
40
+
41
+
To run OpenSearch or Elasticsearch APIs directly against the configured source or target cluster, use a `curl`-like interface. Authentication, TLS, and endpoints are obtained from your console configuration.
*`<source_cluster|target_cluster>` — Specify `source_cluster` or `target_cluster` to call.
51
+
*`<path>` — The API endpoint to call on the cluster (for example, `/_cat/indices` or `/my-index/_search`).
52
+
53
+
#### Options
54
+
55
+
*`--json <JSON_DATA>` — Send a JSON body and automatically set `Content-Type: application/json`.
56
+
*`-X, --request <METHOD>` — The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, or `HEAD`). Default is `GET`.
57
+
*`-H, --header <HEADER>` — A custom header, for example, `-H 'Accept: application/json'`. You can specify multiple headers, for example, `-H 'Accept: application/json' -H 'Authorization: Bearer TOKEN'`.
Creates a snapshot of the source cluster and stores it in a preconfigured Amazon Simple Storage Service (Amazon S3) bucket.
@@ -45,34 +97,37 @@ console snapshot create
45
97
```
46
98
{% include copy.html %}
47
99
48
-
## Check snapshot status
100
+
###Check snapshot status
49
101
50
102
Runs a detailed check on the snapshot creation status, including estimated completion time:
51
103
52
104
```sh
53
105
console snapshot status --deep-check
54
106
```
107
+
55
108
{% include copy.html %}
56
109
57
-
## Evaluate metadata
110
+
###Evaluate metadata
58
111
59
112
Performs a dry run of metadata migration, showing which indexes, templates, and other objects will be migrated to the target cluster.
60
113
61
114
```sh
62
115
console metadata evaluate
63
116
```
117
+
64
118
{% include copy.html %}
65
119
66
-
## Migrate metadata
120
+
###Migrate metadata
67
121
68
122
Migrates the metadata from the source cluster to the target cluster.
69
123
70
124
```sh
71
125
console metadata migrate
72
126
```
127
+
73
128
{% include copy.html %}
74
129
75
-
## Start a backfill
130
+
###Start a backfill
76
131
77
132
If `Reindex-From-Snapshot` (RFS) is enabled, this command starts an instance of the service to begin moving documents to the target cluster:
78
133
@@ -84,12 +139,16 @@ console backfill start
84
139
```
85
140
{% include copy.html %}
86
141
87
-
## Check backfill status
142
+
###Check backfill status
88
143
89
144
Gets the current status of the backfill migration, including the number of operating instances and the progress of the shards.
90
145
146
+
```sh
147
+
console backfill status
148
+
```
149
+
{% include copy.html %}
91
150
92
-
## Start Traffic Replayer
151
+
###Start Traffic Replayer
93
152
94
153
If Traffic Replayer is enabled, this command starts an instance of Traffic Replayer to begin replaying traffic against the target cluster.
95
154
The `stop` command stops all active instances.
@@ -99,7 +158,7 @@ console replay start
99
158
```
100
159
{% include copy.html %}
101
160
102
-
## Read logs
161
+
###Read logs
103
162
104
163
Reads any logs that exist when running Traffic Replayer. Use tab completion on the path to fill in the available `NODE_IDs` and, if applicable, log file names. The tuple logs roll over at a certain size threshold, so there may be many files named with timestamps. The `jq` command pretty-prints each line of the tuple output before writing it to file.
105
164
@@ -108,7 +167,7 @@ console tuples show --in /shared-logs-output/traffic-replayer-default/[NODE_ID]/
108
167
```
109
168
{% include copy.html %}
110
169
111
-
## Show version
170
+
###Show version
112
171
113
172
Displays the version of the currently installed Migration Assistant.
114
173
@@ -117,11 +176,11 @@ console --version
117
176
```
118
177
{% include copy.html %}
119
178
120
-
## Help option
179
+
###Help option
121
180
122
181
All commands and options can be explored within the tool itself by using the `--help` option, either for the entire `console` application or for individual components (for example, `console backfill --help`). For example:
0 commit comments