Servers
Add remote servers over SSH, validate them and read their metrics and services. Generated from the `notploy` command surface.
Add remote servers over SSH, validate them and read their metrics and services.
notploy server exposes 21 commands. They map one-to-one onto the server.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy server --help to list these commands in your terminal, or
notploy server <command> --help for a single command.
Commands
notploy server all
Calls GET /api/trpc/server.all.
notploy server all [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server all-for-permissions
Calls GET /api/trpc/server.allForPermissions.
notploy server all-for-permissions [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server build-servers
Calls GET /api/trpc/server.buildServers.
notploy server build-servers [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server count
Calls GET /api/trpc/server.count.
notploy server count [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server create
Calls POST /api/trpc/server.create.
notploy server create --name <value> --description <value> --ipAddress <value> --port <value> --username <value> --sshKeyId <value> --serverType <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--description <value> | string | Yes | — |
--ipAddress <value> | string | Yes | — |
--port <value> | number | Yes | — |
--username <value> | string | Yes | — |
--sshKeyId <value> | string | Yes | — |
--serverType <value> | string | Yes | deploy, build |
--enableDockerCleanup [boolean] | boolean | No | — |
--no-enableDockerCleanup | boolean | No | — |
--profile <name> | string | No | — |
notploy server create-with-password
Calls POST /api/trpc/server.createWithPassword.
notploy server create-with-password --name <value> --description <value> --ipAddress <value> --port <value> --username <value> --serverType <value> --sshPassword <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--description <value> | string | Yes | — |
--ipAddress <value> | string | Yes | — |
--port <value> | number | Yes | — |
--username <value> | string | Yes | — |
--serverType <value> | string | Yes | deploy, build |
--enableDockerCleanup [boolean] | boolean | No | — |
--no-enableDockerCleanup | boolean | No | — |
--sshPassword <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server get-default-command
Calls GET /api/trpc/server.getDefaultCommand.
notploy server get-default-command --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server get-monitoring-workspaces
Calls GET /api/trpc/server.getMonitoringWorkspaces.
notploy server get-monitoring-workspaces [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server get-server-metrics
Calls GET /api/trpc/server.getServerMetrics.
notploy server get-server-metrics --url <value> --token <value> --dataPoints <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--url <value> | string | Yes | — |
--token <value> | string | Yes | — |
--dataPoints <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server get-server-time
Calls GET /api/trpc/server.getServerTime.
notploy server get-server-time [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server get-services
Calls GET /api/trpc/server.getServices.
notploy server get-services --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server one
Calls GET /api/trpc/server.one.
notploy server one --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server public-ip
Calls GET /api/trpc/server.publicIp.
notploy server public-ip [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy server remove
Calls POST /api/trpc/server.remove.
notploy server remove --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server security
Calls GET /api/trpc/server.security.
notploy server security --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server setup
Calls POST /api/trpc/server.setup.
notploy server setup --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server setup-monitoring
Calls POST /api/trpc/server.setupMonitoring.
notploy server setup-monitoring --serverId <value> --metricsConfig <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--metricsConfig <json> | object | Yes | — |
--profile <name> | string | No | — |
notploy server update
Calls POST /api/trpc/server.update.
notploy server update --name <value> --description <value> --serverId <value> --ipAddress <value> --port <value> --username <value> --sshKeyId <value> --serverType <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--description <value> | string | Yes | — |
--serverId <value> | string | Yes | — |
--ipAddress <value> | string | Yes | — |
--port <value> | number | Yes | — |
--username <value> | string | Yes | — |
--sshKeyId <value> | string | Yes | — |
--serverType <value> | string | Yes | deploy, build |
--enableDockerCleanup [boolean] | boolean | No | — |
--no-enableDockerCleanup | boolean | No | — |
--command <value> | string | No | — |
--profile <name> | string | No | — |
notploy server update-builds-concurrency
Calls POST /api/trpc/server.updateBuildsConcurrency.
notploy server update-builds-concurrency --serverId <value> --buildsConcurrency <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--buildsConcurrency <value> | number | Yes | — |
--profile <name> | string | No | — |
notploy server validate
Calls GET /api/trpc/server.validate.
notploy server validate --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy server with-sshkey
Calls GET /api/trpc/server.withSSHKey.
notploy server with-sshkey [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |