feat(instances): allow disabling prefixes in aliases and TUI
This commit is contained in:
1 parent
1f46d9d9e5
commit
20d7a40543
12 files changed
+298
-19
No files matched your search
@@ -212,7 +212,7 @@ Every key, its default, and the section that explains it. Keys marked *layered*
|
||||
| `netbox.url` | string | — | NetBox base URL (single instance). Use either `netbox` or `netboxes`. |
|
||||
| `netbox.token` | string | — | API token; `nbt_…` is v2, anything else v1. |
|
||||
| `netbox.token_version` | 1 \| 2 | auto | Detected from the token prefix. |
|
||||
| `netboxes[]` | list | — | Named instances with `name`, `url`, `token`, `token_version`, `ssh` — see [Multiple NetBox instances](#multiple-netbox-instances). |
|
||||
| `netboxes[]` | list | — | Named instances with `name`, `url`, `token`, `token_version`, `disable_prefix`, `ssh` — see [Multiple NetBox instances](#multiple-netbox-instances). |
|
||||
| `resolver.strategies` | list | `[management_subnet, primary_ip]` | Tried in order, first IP wins — see [IP Resolution Strategies](#ip-resolution-strategies). The wizard suggests `primary_ip`. |
|
||||
| `resolver.management_subnets` | list of CIDR | `[]` | Used by `management_subnet`. |
|
||||
| `resolver.interface_name` | string | — | Used by `interface_name`, e.g. `mgmt0`. |
|
||||
@@ -306,7 +306,41 @@ netssh notes show lab/web01 --netbox --kind device
|
||||
|
||||
For direct connections without an instance prefix, every instance must be reachable to verify uniqueness. A qualified target queries only its own instance and can use a fresh cached IP while other instances are offline. Qualified shortcuts such as `office/web01` also support configured domain suffixes and hyphen folding.
|
||||
|
||||
Cache entries and generated aliases retain the instance name (`office_web01` and `lab_web01`). Named-instance caches live in a configuration-specific subdirectory beneath the configured cache path, so changing an endpoint cannot reuse another server's cached IPs. Run `netssh cache refresh` after adding or changing instances. A failed full refresh leaves the cache and its refresh timestamp unchanged; a per-instance refresh preserves the other instances and does not mark the whole cache as refreshed.
|
||||
Cache entries retain the instance name. Generated aliases include it by default (`office_web01` and `lab_web01`). Named-instance caches live in a configuration-specific subdirectory beneath the configured cache path, so changing an endpoint cannot reuse another server's cached IPs. Run `netssh cache refresh` after adding or changing instances. A failed full refresh leaves the cache and its refresh timestamp unchanged; a per-instance refresh preserves the other instances and does not mark the whole cache as refreshed.
|
||||
|
||||
**Aliases and TUI names without an instance prefix.** Set `disable_prefix: true`
|
||||
on individual instances, or enable **Hide instance prefix in aliases and TUI?**
|
||||
when editing an instance in `netssh configure`:
|
||||
|
||||
```yaml
|
||||
netboxes:
|
||||
- name: office
|
||||
url: https://netbox.office.example
|
||||
token: nbt_office-token
|
||||
disable_prefix: true
|
||||
- name: lab
|
||||
url: https://netbox.lab.example
|
||||
token: nbt_lab-token
|
||||
```
|
||||
|
||||
With the appropriate domain shortcut, this generates `web01` for
|
||||
`office/web01.example.com` and `lab_web01` for the lab host. The default is
|
||||
`false`. The alias command still contains the full `instance/hostname`, so it
|
||||
connects to the selected instance even when another instance has the same host
|
||||
name. Domain stripping, rewrites and hyphen folding still apply.
|
||||
|
||||
If a bare alias conflicts with another generated alias, a reserved qualified
|
||||
alias, `netssh`, or your configured command alias, the instance prefix is kept.
|
||||
It is also kept if the bare name is not a valid shell alias (e.g. starts with a digit).
|
||||
The TUI result list also hides the prefix for this instance; duplicate visible
|
||||
names keep their prefixes to remain distinguishable. Selection, autocomplete,
|
||||
connection editors, notes and cache identities still use the full target.
|
||||
Completion already offers unique hostnames
|
||||
without an instance prefix.
|
||||
|
||||
Open a new shell with the installed netssh hook to regenerate and load aliases.
|
||||
No cache refresh is needed for this setting. Existing aliases in an already open
|
||||
shell remain until removed or the shell is replaced.
|
||||
|
||||
Local notes remain keyed by the NetBox URL, host kind, and canonical hostname. Migrating a single instance or renaming it preserves its notes. Use `instance/hostname` and `--kind` for uncached local notes; these operations work offline. NetBox comments and interface/IP lookups always use the selected instance's credentials.
|
||||
|
||||
|
||||
Reference in new issue
Block a user