# NetBox

Canonical: https://docs.shumoku.dev/ja/server/next/plugins/netbox
Language: ja
Server documentation version: next
Product version: 0.1.6-beta.4
Channel: development

このドキュメントは開発中のServerを対象としています。

netbox · 0.2.28

# NetBox

[ソース](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/netbox/src/index.ts)

フィールドの説明は英語のcanonical descriptorを表示しています。

## Capability

topology · hosts

## 接続設定

| フィールド | 型 | 説明 | 既定値 |
| --- | --- | --- | --- |
| `url`  
必須 | `string` | **NetBox URL**  
 | `—` |
| `token`  
必須 · Secret | `string` | **API token**  
 | `—` |
| `insecure`  
 | `boolean` | **Skip TLS verification**  
Disables certificate validation. Self-signed certs in trusted networks only. | `false` |

## Topologyオプション

| フィールド | 型 | 説明 | 既定値 |
| --- | --- | --- | --- |
| `groupBy`  
 | `string` | **Group by**  
tag — Tag, site — Site, location — Location, prefix — Prefix, none — No grouping | `tag` |
| `siteFilter`  
 | `string[]` | **Sites**  
 | `—` |
| `tagFilter`  
 | `string[]` | **Tags**  
 | `—` |
| `roleFilter`  
 | `string[]` | **Roles**  
 | `—` |
| `excludeRoleFilter`  
 | `string[]` | **Exclude roles**  
 | `—` |
| `excludeTagFilter`  
 | `string[]` | **Exclude tags**  
 | `—` |