Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions docs/reference/replicated-cli-network-report.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# replicated network report

Get network report

### Synopsis

Get a network report showing detailed network activity for a specified network.

The report shows individual network events including source/destination IPs, ports, protocols,
pods, processes, and DNS queries. Reports must be enabled with 'replicated network update NETWORK_ID --collect-report'.

Output formats:
- Default: Full event details in JSON format
- --summary: Aggregated statistics with top domains and destinations
- --watch: Continuous stream of new events in JSON Lines format

```
replicated network report [NETWORK_ID] [flags]
```

### Examples

```
# Get full network traffic report (external traffic only)
replicated network report NETWORK_ID

# Get aggregated summary with statistics. Only available for networks that have been terminated.
replicated network report NETWORK_ID --summary

# Watch for new network events in real-time
replicated network report NETWORK_ID --watch
```

### Options

```
-h, --help help for report
--id string Network ID to get report for
--summary Get aggregated report summary with statistics instead of individual events
-w, --watch Watch for new network events in real-time (polls every 2 seconds)
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--debug Enable debug output
--profile string The authentication profile to use for this command
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated network](replicated-cli-network) - Manage test networks for VMs and Clusters

10 changes: 5 additions & 5 deletions docs/reference/replicated-cli-network-update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ replicated network update [ID_OR_NAME] [flags]

```
# Set network policy to airgap
replicated network update <network-id> --policy airgap
replicated network update NETWORK_ID --policy airgap

# Set network policy to open
replicated network update <network-id> --policy open
replicated network update NETWORK_ID --policy open

# Enable network traffic reporting
replicated network update <network-id> --collect-report
replicated network update NETWORK_ID --collect-report

# Disable network reporting
replicated network update <network-id> --collect-report=false
replicated network update NETWORK_ID --collect-report=false

# Update multiple settings at once
replicated network update <network-id> --policy airgap --collect-report
replicated network update NETWORK_ID --policy airgap --collect-report

```

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/replicated-cli-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ With this command you can list the networks in use by VMs and clusters.
replicated network ls

# Update a network with an airgap policy
replicated network update <network-id> --policy airgap
replicated network update NETWORK_ID --policy airgap

```

Expand All @@ -37,5 +37,6 @@ replicated network update <network-id> --policy airgap

* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated
* [replicated network ls](replicated-cli-network-ls) - List test networks
* [replicated network report](replicated-cli-network-report) - Get network report
* [replicated network update](replicated-cli-network-update) - Update network settings

1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,7 @@ const sidebars = {
"reference/replicated-cli-logout",
"reference/replicated-cli-network",
"reference/replicated-cli-network-ls",
"reference/replicated-cli-network-report",
"reference/replicated-cli-network-update",
"reference/replicated-cli-profile",
"reference/replicated-cli-profile-add",
Expand Down