Skip to content

Commit 944f476

Browse files
committed
Update CLI reference
1 parent ed4c8a6 commit 944f476

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# replicated network report
2+
3+
Get network report
4+
5+
### Synopsis
6+
7+
Get a report showing network events for a specified network. You can view all network events, or use the --summary flag to see an aggregated analysis of captured network events.
8+
9+
Network reporting is a beta feature. For more information, see [Test in Air Gap Environments (Beta)](/vendor/testing-network-policy).
10+
11+
```
12+
replicated network report [network-id] [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
# Get report for a network by ID (using positional argument)
19+
replicated network report abc123
20+
21+
# Get report for a network by ID (using flag)
22+
replicated network report --id abc123
23+
24+
# Watch for new network events (JSON Lines format)
25+
replicated network report abc123 --watch
26+
```
27+
28+
### Options
29+
30+
```
31+
-h, --help help for report
32+
--id string Network ID to get report for
33+
--summary Get the report summary
34+
-w, --watch Watch for new network events
35+
```
36+
37+
### Options inherited from parent commands
38+
39+
```
40+
--app string The app slug or app id to use in all calls
41+
--debug Enable debug output
42+
--token string The API token to use to access your app in the Vendor API
43+
```
44+
45+
### SEE ALSO
46+
47+
* [replicated network](replicated-cli-network) - Manage test networks for VMs and Clusters
48+
49+

docs/reference/replicated-cli-network.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ replicated network ls
1616
# Update a network with an airgap policy
1717
replicated network update <network-id> --policy airgap
1818
19+
# View network report
20+
replicated network report <network-id> --summary
21+
1922
```
2023

2124
### Options
@@ -36,5 +39,6 @@ replicated network update <network-id> --policy airgap
3639

3740
* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated
3841
* [replicated network ls](replicated-cli-network-ls) - List test networks
42+
* [replicated network report](replicated-cli-network-report) - View network activity reports
3943
* [replicated network update](replicated-cli-network-update) - Update network settings
4044

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,7 @@ const sidebars = {
673673
'reference/replicated-cli-logout',
674674
'reference/replicated-cli-network',
675675
'reference/replicated-cli-network-ls',
676+
'reference/replicated-cli-network-report',
676677
'reference/replicated-cli-network-update',
677678
'reference/replicated-cli-registry',
678679
'reference/replicated-cli-registry-add',

0 commit comments

Comments
 (0)