veirox connector
Manage Connect connectors
Synopsis
veirox connector <subcommand> [args] [flags]
Description
Manage Connect connectors
Subcommands
| Command | Description |
|---|---|
veirox connector add <name> | Register a new connector |
veirox connector auth-events <connector-id> | Show recent auth events for a connector |
veirox connector enroll <connector-id> | Issue an enrollment token and (by default) wait for the connector to come online |
veirox connector info <connector-id> | Show one connector |
veirox connector list | List connectors |
veirox connector logs <connector-id> | Show recent commands run via this connector |
veirox connector policy | Inspect or simulate connector policy |
veirox connector revoke <connector-id> | Revoke a connector's mTLS credential |
veirox connector rm <connector-id> | Delete a connector |
veirox connector update <connector-id> | Update a connector |
veirox connector upstream | Inspect connector upstreams |
veirox connector add <name>
Register a new connector
| Flag | Type | Default | Description |
|---|---|---|---|
--connector-context | string | — | connector-facing context blob |
--deny-command | stringSlice | [] | additional denylist entries |
--description | string | — | human-readable description |
--label | stringSlice | [] | key=value label (repeat for multiple) |
veirox connector add prod-bastion --description 'prod jumpbox' --label env=prod
veirox connector auth-events <connector-id>
Show recent auth events for a connector
| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 0 | page size |
--offset | int | 0 | pagination offset |
veirox connector auth-events <uuid> --limit 25
veirox connector enroll <connector-id>
Issue an enrollment token and (by default) wait for the connector to come online
| Flag | Type | Default | Description |
|---|---|---|---|
--no-open | bool | false | don't try to open the install URL |
--print-only | bool | false | print install command and exit |
--runtime | string | systemd | connector runtime: systemd | docker | manual |
veirox connector enroll <uuid> --runtime systemd
veirox connector info <connector-id>
Show one connector
veirox connector info <uuid>
veirox connector list
List connectors
| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 0 | page size |
--offset | int | 0 | pagination offset |
veirox connector list --limit 25
veirox connector logs <connector-id>
Show recent commands run via this connector
| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 0 | page size |
--offset | int | 0 | pagination offset |
veirox connector logs <uuid> --limit 25
veirox connector policy
Inspect or simulate connector policy
veirox connector revoke <connector-id>
Revoke a connector's mTLS credential
| Flag | Type | Default | Description |
|---|---|---|---|
--yes | bool | false | confirm revoke |
veirox connector revoke <uuid> --yes
veirox connector rm <connector-id>
Delete a connector
| Flag | Type | Default | Description |
|---|---|---|---|
--yes | bool | false | confirm deletion |
veirox connector rm <uuid> --yes
veirox connector update <connector-id>
Update a connector
| Flag | Type | Default | Description |
|---|---|---|---|
--connector-context | string | — | new connector context |
--description | string | — | new description |
--label | stringSlice | [] | new key=value labels |
--name | string | — | new name |
veirox connector update <uuid> --name new-name --label env=stg
veirox connector upstream
Inspect connector upstreams
Exit codes
| Code | Meaning |
|---|---|
0 | Success. |
1 | Generic error (network, API 5xx). |
2 | Validation error (bad flag, missing required arg). |
3 | Unauthenticated — run veirox login or set VEIROX_API_KEY. |
4 | Not found (resource does not exist in this project). |
5 | Permission denied (your role / API key lacks the scope). |