CLICommand referenceservernetworkoperation server network operation
Commands, arguments, and options for openship server network operation.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
Review and execute an exact managed-network plan
openship server network operation [options] [command]
Apply, resume or roll back a reviewed plan without rebuilding it
openship server network operation apply [options] <id>
| Argument | Meaning |
|---|
id | Operation ID |
| Option | Meaning |
|---|
--plan-hash <hash> | Exact hash of the plan you reviewed |
--action <action> | Execution action (choices: "apply", "resume", "rollback", default: "apply") |
-y, --yes | Confirm this plan's host changes |
Discard a plan using its exact hash
openship server network operation discard [options] [file]
| Argument | Meaning |
|---|
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
-y, --yes | Confirm this operation |
Stream plan execution and recovery progress
openship server network operation events [options] <id>
| Argument | Meaning |
|---|
id | Operation ID |
| Option | Meaning |
|---|
--timeout <ms> | Stop after this deadline |
Read a plan, its hash and execution progress
openship server network operation get [options] <id>
| Argument | Meaning |
|---|
id | Operation ID |
Plan managed-network configuration or removal with an idempotent request ID
openship server network operation plan [options] [file]
| Argument | Meaning |
|---|
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
Remove a host using the operation's exact plan hash and sequence
openship server network operation remove-member [options] [file]
| Argument | Meaning |
|---|
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
-y, --yes | Confirm this operation |