Networks
Docker networks: create, import, inspect and resynchronise them across servers. Generated from the `notploy` command surface.
Docker networks: create, import, inspect and resynchronise them across servers.
notploy network exposes 10 commands. They map one-to-one onto the network.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy network --help to list these commands in your terminal, or
notploy network <command> --help for a single command.
Commands
notploy network all
Calls GET /api/trpc/network.all.
notploy network all [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | No | — |
--profile <name> | string | No | — |
notploy network create
Calls POST /api/trpc/network.create.
notploy network create --name <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--driver <value> | string | No | bridge, overlay |
--internal [boolean] | boolean | No | — |
--no-internal | boolean | No | — |
--attachable [boolean] | boolean | No | — |
--no-attachable | boolean | No | — |
--enableIPv4 [boolean] | boolean | No | — |
--no-enableIPv4 | boolean | No | — |
--enableIPv6 [boolean] | boolean | No | — |
--no-enableIPv6 | boolean | No | — |
--mtu <value> | number | No | — |
--ipam <json> | object | No | — |
--serverId <value> | string | No | — |
--networkProviderId <value> | string | No | — |
--profile <name> | string | No | — |
notploy network import
Calls POST /api/trpc/network.import.
notploy network import --names <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | No | — |
--names <json> | array | Yes | — |
--profile <name> | string | No | — |
notploy network inspect
Calls GET /api/trpc/network.inspect.
notploy network inspect --networkId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--networkId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy network inventory
Calls GET /api/trpc/network.inventory.
notploy network inventory [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | No | — |
--profile <name> | string | No | — |
notploy network networks-to-sync
Calls GET /api/trpc/network.networksToSync.
notploy network networks-to-sync [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | No | — |
--profile <name> | string | No | — |
notploy network one
Calls GET /api/trpc/network.one.
notploy network one --networkId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--networkId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy network recreate
Calls POST /api/trpc/network.recreate.
notploy network recreate --networkId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--networkId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy network remove
Calls POST /api/trpc/network.remove.
notploy network remove --networkId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--networkId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy network resync
Calls POST /api/trpc/network.resync.
notploy network resync --networkId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--networkId <value> | string | Yes | — |
--profile <name> | string | No | — |