CLICommand referenceservernetwork

server network

Commands, arguments, and options for openship server network.

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

openship server network

Manage private networks and reviewed network operations

openship server network [options] [command]
SubcommandPurpose
capabilitiesShow network providers and available operations
listList private networks
get <id>Read network members, revision and verification
inspect-host <server>Inspect a server's interfaces and network readiness
create [options] [file]Register a private network and its existing host interfaces
update [options] [file]Update a network using its exact current revision
verify [options] [file]Verify connectivity and optional throughput at a saved revision
remove [options] <id>Remove this network if its current state permits it
events [options]Stream changes to private networks
preparationPrepare managed networking and recover interrupted preparation
operationReview and execute an exact managed-network plan

openship server network capabilities

Show network providers and available operations

openship server network capabilities [options]

openship server network create

Register a private network and its existing host interfaces

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

openship server network events

Stream changes to private networks

openship server network events [options]
OptionMeaning
--timeout <ms>Stop after this deadline

openship server network get

Read network members, revision and verification

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

openship server network inspect-host

Inspect a server's interfaces and network readiness

openship server network inspect-host [options] <server>
ArgumentMeaning
serverServer ID

openship server network list

List private networks

openship server network list [options]

openship server network remove

Remove this network if its current state permits it

openship server network remove [options] <id>
ArgumentMeaning
idNetwork ID
OptionMeaning
--revision <number>Revision from network get
-y, --yesConfirm removal

openship server network update

Update a network using its exact current revision

openship server network update [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 verify

Verify connectivity and optional throughput at a saved revision

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

On this page