CLICommand referenceservernetworkpreparation

server network preparation

Commands, arguments, and options for openship server network preparation.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship server network preparation

Prepare managed networking and recover interrupted preparation

openship server network preparation [options] [command]
SubcommandPurpose
listList in-progress and recoverable preparations
get <id>Read preparation steps, access policy and sequence
create [options] [file]Start an idempotent managed-network preparation
access [options] [file]Revise a preparation's reviewed access policy
remove-member [options] [file]Remove a host from a preparation using its exact sequence
discard [options] [file]Discard the selected preparation at its current sequence
events [options] <id>Stream preparation progress

openship server network preparation access

Revise a preparation's reviewed access policy

openship server network preparation access [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 preparation create

Start an idempotent managed-network preparation

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

openship server network preparation discard

Discard the selected preparation at its current sequence

openship server network preparation 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 preparation events

Stream preparation progress

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

openship server network preparation get

Read preparation steps, access policy and sequence

openship server network preparation get [options] <id>
ArgumentMeaning
idPreparation ID

openship server network preparation list

List in-progress and recoverable preparations

openship server network preparation list [options]

openship server network preparation remove-member

Remove a host from a preparation using its exact sequence

openship server network preparation 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