From 6ca3b122b1f673609e4f90c86e99e30630175afb Mon Sep 17 00:00:00 2001 From: Replicated Release Pipeline Date: Mon, 25 Aug 2025 17:35:29 +0000 Subject: [PATCH] Update Replicated CLI docs for v0.113.0 --- .../replicated-cli-network-update.mdx | 61 +++++++++++++++++++ docs/reference/replicated-cli-network.mdx | 1 + sidebars.js | 1 + 3 files changed, 63 insertions(+) create mode 100644 docs/reference/replicated-cli-network-update.mdx diff --git a/docs/reference/replicated-cli-network-update.mdx b/docs/reference/replicated-cli-network-update.mdx new file mode 100644 index 0000000000..8ff4f0812e --- /dev/null +++ b/docs/reference/replicated-cli-network-update.mdx @@ -0,0 +1,61 @@ +# replicated network update + +Update network settings. + +### Synopsis + +The 'update' command allows you to update various settings of a test network. + +You can either specify the network ID directly or provide the network name, and the command will resolve the corresponding network ID. + +Network Policies are currently a beta feature, and network reporting is currently an alpha feature. + +``` +replicated network update [ID_OR_NAME] [flags] +``` + +### Examples + +``` +# Update a network using its ID +replicated network update --policy airgap + +# Update a network using its name +replicated network update --policy airgap + +# Update using --id or --name flags +replicated network update --id --policy airgap +replicated network update --name --policy airgap + +# Enable report collection on a network +replicated network update --collect-report + +# Disable report collection on a network +replicated network update --collect-report=false + +# Update both policy and report collection on a network +replicated network update --policy airgap --collect-report +``` + +### Options + +``` + -h, --help help for update + --id string id of the network to update (when name is not provided) + --name string Name of the network to update. + --output string The output format to use. One of: json|table|wide (default "table") + --policy string Update network policy setting +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --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 + diff --git a/docs/reference/replicated-cli-network.mdx b/docs/reference/replicated-cli-network.mdx index f375042522..27175543a8 100644 --- a/docs/reference/replicated-cli-network.mdx +++ b/docs/reference/replicated-cli-network.mdx @@ -32,4 +32,5 @@ replicated network ls * [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated * [replicated network ls](replicated-cli-network-ls) - List test networks +* [replicated network update](replicated-cli-network-update) - Update network settings. diff --git a/sidebars.js b/sidebars.js index d53c3f47b1..40e18644b2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -731,6 +731,7 @@ const sidebars = { 'reference/replicated-cli-logout', 'reference/replicated-cli-network', 'reference/replicated-cli-network-ls', + 'reference/replicated-cli-network-update', 'reference/replicated-cli-registry', 'reference/replicated-cli-registry-add', 'reference/replicated-cli-registry-add-dockerhub',