Configuration reference
Generated from the Pydantic models in nsc/config/models.py.
All fields below describe ~/.nsc/config.yaml.
Config
| Field |
Type |
Default |
default_profile |
str | None |
None |
profiles |
dict[str, Profile] |
{} |
defaults |
<class 'Defaults'> |
Defaults(output=<OutputFormat.TABLE: 'table'>, page_size=50, timeout=30.0, schema_refresh=<SchemaRefresh.DAILY: 'daily'>, color_mode=<ColorMode.AUTO: 'auto'>, object_colors=<ObjectColorMode.AUTO: 'auto'>, audit_redaction=<AuditRedaction.SAFE: 'safe'>) |
columns |
dict[str, dict[str, list[str]]] |
{} |
saved_searches |
dict[str, dict[str, dict[str, dict[str, str]]]] |
{} |
Profile
| Field |
Type |
Default |
name |
<class 'str'> |
(required) |
url |
<class 'pydantic.networks.HttpUrl'> |
(required) |
token |
str | None |
None |
verify_ssl |
<class 'bool'> |
True |
schema_url |
pydantic.networks.HttpUrl | None |
None |
timeout |
float | None |
None |
Defaults
| Field |
Type |
Default |
output |
<enum 'OutputFormat'> |
<OutputFormat.TABLE: 'table'> |
page_size |
<class 'int'> |
50 |
timeout |
<class 'float'> |
30.0 |
schema_refresh |
<enum 'SchemaRefresh'> |
<SchemaRefresh.DAILY: 'daily'> |
color_mode |
<enum 'ColorMode'> |
<ColorMode.AUTO: 'auto'> |
object_colors |
<enum 'ObjectColorMode'> |
<ObjectColorMode.AUTO: 'auto'> |
audit_redaction |
<enum 'AuditRedaction'> |
<AuditRedaction.SAFE: 'safe'> |