Skip to content

Commit 406afa1

Browse files
Replicated Release Pipelinemikhailswift
authored andcommitted
Update Replicated CLI docs for v0.113.0
1 parent d23b197 commit 406afa1

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# replicated network update
2+
3+
Update network settings.
4+
5+
### Synopsis
6+
7+
The 'update' command allows you to update various settings of a test network.
8+
9+
You can either specify the network ID directly or provide the network name, and the command will resolve the corresponding network ID.
10+
11+
Network Policies are currently a beta feature, and network reporting is currently an alpha feature.
12+
13+
```
14+
replicated network update [ID_OR_NAME] [flags]
15+
```
16+
17+
### Examples
18+
19+
```
20+
# Update a network using its ID
21+
replicated network update <network-id> --policy airgap
22+
23+
# Update a network using its name
24+
replicated network update <network-name> --policy airgap
25+
26+
# Update using --id or --name flags
27+
replicated network update --id <network-id> --policy airgap
28+
replicated network update --name <network-name> --policy airgap
29+
30+
# Enable report collection on a network
31+
replicated network update <network-id> --collect-report
32+
33+
# Disable report collection on a network
34+
replicated network update <network-id> --collect-report=false
35+
36+
# Update both policy and report collection on a network
37+
replicated network update <network-id> --policy airgap --collect-report
38+
```
39+
40+
### Options
41+
42+
```
43+
-h, --help help for update
44+
--id string id of the network to update (when name is not provided)
45+
--name string Name of the network to update.
46+
--output string The output format to use. One of: json|table|wide (default "table")
47+
--policy string Update network policy setting
48+
```
49+
50+
### Options inherited from parent commands
51+
52+
```
53+
--app string The app slug or app id to use in all calls
54+
--debug Enable debug output
55+
--token string The API token to use to access your app in the Vendor API
56+
```
57+
58+
### SEE ALSO
59+
60+
* [replicated network](replicated-cli-network) - Manage test networks for VMs and Clusters
61+

docs/reference/replicated-cli-network.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ replicated network ls
3232

3333
* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated
3434
* [replicated network ls](replicated-cli-network-ls) - List test networks
35+
* [replicated network update](replicated-cli-network-update) - Update network settings.
3536

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -731,6 +731,7 @@ const sidebars = {
731731
'reference/replicated-cli-logout',
732732
'reference/replicated-cli-network',
733733
'reference/replicated-cli-network-ls',
734+
'reference/replicated-cli-network-update',
734735
'reference/replicated-cli-registry',
735736
'reference/replicated-cli-registry-add',
736737
'reference/replicated-cli-registry-add-dockerhub',

0 commit comments

Comments
 (0)