Documentación de Oktavia · Referencia de datos
Referencia de datos
Tablas de campos con tipo, obligatoriedad, alcance, fuente y descripción: inventario base, inventario de equipos, petición y detalle de jobs, reglas de cumplimiento y variables de servicio.
Cómo leer estas tablas
Cada tabla describe un archivo o un contrato de la plataforma, una fila por campo, con las mismas seis columnas. Se generan del catálogo del portal y tienen un filtro para encontrar un campo sin desplazarse.
- Campo
- El nombre tal como aparece en el archivo o en la API.
- Tipo
- Tipo de dato y, cuando es una enumeración, sus valores.
- Obligatorio
- Sí, No, Práctico (el archivo lo acepta vacío pero la plataforma no funciona bien sin él), Derivado (lo calcula el Engine) o la condición que lo hace obligatorio.
- Scope
- A qué aplica o dónde vive: el equipo, la petición, la regla, un alcance de la intención, o el objeto padre cuando el campo es anidado.
- Fuente
- El archivo, modelo o módulo que lo define.
- Descripción
- Qué significa y qué efecto tiene en la plataforma.
Inventario base
Columnas del CSV de equipos (devices.csv) que el Engine convierte en su inventario interno, y que la UI acepta en su importación. Es la semilla operativa: lo que el discovery después enriquece. Guía: Inventario.
Device Inventory
Campos de device_inventory.json, el inventario canónico que construye el Engine a partir del discovery (más device_tags.json e interface_tags.json) y que consumen el Config Generator, compliance y la UI. Los cinco últimos campos viven dentro de capabilities.
API / Jobs
Campos de la petición de auditoría que aceptan todas las operaciones de auditoría de la API del Engine, y del detalle de job que devuelve la consulta de un job. Guía: Auditorías; referencia: API del Engine.
Compliance / Intended
Estructura de intended.json (y de intended.yaml, idéntica): el archivo de reglas que el Engine evalúa contra el snapshot normalizado y el respaldo. Por organización lo escribe la UI y no se edita a mano. Guía: Compliance.
Service Vars
Estructura de service_vars.json: los alcances en los que se declara la intención y los servicios que se configuran dentro de cada uno. El Configurador es su editor; el Engine lo consume al renderizar. Precedencia de menor a mayor: defaults, by_site, by_site_type, by_role, by_platform, by_model, by_tag, by_filter, by_device. Los servicios de la tabla son los de Cisco IOS; los de FortiGate, Junos y FortiSwitch llevan los prefijos fgt_, jnpr_ y fsw_ y están en Integraciones. Guía: Cuándo usar cada alcance.