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.

openship server network operation

Review and execute an exact managed-network plan

openship server network operation [options] [command]
SubcommandPurpose
plan [options] [file]Plan managed-network configuration or removal with an idempotent request ID
get <id>Read a plan, its hash and execution progress
apply [options] <id>Apply, resume or roll back a reviewed plan without rebuilding it
discard [options] [file]Discard a plan using its exact hash
remove-member [options] [file]Remove a host using the operation's exact plan hash and sequence
events [options] <id>Stream plan execution and recovery progress

openship server network operation apply

Apply, resume or roll back a reviewed plan without rebuilding it

openship server network operation apply [options] <id>
ArgumentMeaning
idOperation ID
OptionMeaning
--plan-hash <hash>Exact hash of the plan you reviewed
--action <action>Execution action (choices: "apply", "resume", "rollback", default: "apply")
-y, --yesConfirm this plan's host changes

openship server network operation discard

Discard a plan using its exact hash

openship server network operation discard [options] [file]
ArgumentMeaning
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request
-y, --yesConfirm this operation

openship server network operation events

Stream plan execution and recovery progress

openship server network operation events [options] <id>
ArgumentMeaning
idOperation ID
OptionMeaning
--timeout <ms>Stop after this deadline

openship server network operation get

Read a plan, its hash and execution progress

openship server network operation get [options] <id>
ArgumentMeaning
idOperation ID

openship server network operation plan

Plan managed-network configuration or removal with an idempotent request ID

openship server network operation plan [options] [file]
ArgumentMeaning
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request

openship server network operation remove-member

Remove a host using the operation's exact plan hash and sequence

openship server network operation remove-member [options] [file]
ArgumentMeaning
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request
-y, --yesConfirm this operation

On this page