Plantillas de configuración (API)
Para obtener la documentación completa de la API, consulte la referencia de api de plataforma desde la interfaz web. Esta es una sección específica para demostrar la API de configuración de manera similar a la interfaz de usuario. La principal diferencia entre la Interfaz de usuario web y la API de REST es que la API de Apstra no hace ningún uso de los configlets almacenados en api/design/configlets cuando se trabaja con un plano. Los design-configlets están diseñados para el consumo en la interfaz de usuario. Cuando trabaje con configlets en la API, trabaje directamente con el plano.
Los configlets viven en http://aos-server/api/design/configlets y se hacen referencia por ID.
{
"ref_archs": [
"two_stage_l3clos"
],
"created_at": "string",
"last_modified_at": "string",
"id": "string",
"generators": [
{
"config_style": "string",
"template_text": "string",
"negation_template_text": "string"
}
],
"display_name": "string",
"section": "string"
}
API: crear configlet
Para crear un configlet, POST to https://aos-server/api/design/configlets con una estructura JSON válida que representa el configlet. Puede asignar este configlet desde la GUI de Apstra. Este método no es necesario para que la API de REST se asigne a un plano. Consulte la sección asignar un configlet para obtener más información.
Un POST creará un nuevo configlet. Un PUT sobrescribirá un configlet existente. PUT requiere la dirección URL del configlet. https://aos-server/api/design/configlets/{id}
curl -H "AuthToken: EXAMPLE" -d '{"display_name":"DNS","ref_archs":["two_stage_l3clos"],"section":"system","generators":[{"config_style":"eos","template_text":"ip name-server 192.168.1.1","negation_template_text":"no ip name-server 192.168.1.1"}]}' -X POST "http://aos-server/api/design/configlets"
La respuesta contendrá el ID del configlet recién creado {"id": "995446c7-de7d-46bb-a88a-786839556064"}
API: Eliminar configlet
La eliminación de un configlet requiere un HTTP DELETE a la configlet por URL http://aos-server/api/design/configlets/{id}
curl -H "AuthToken: EXAMPLE" -X DELETE "http://aos-server/api/design/configlets/995446c7-de7d-46bb-a88a-786839556064"
Una eliminación correcta tiene una respuesta vacía {}
API: asignar configlet
La asignación de un configlet a un plano requiere la asignación de condiciones del dispositivo, así como la incrustación de los detalles del configlet. Cuando se asigna un configlet a un plano, no se necesitan los configlets disponibles como recursos de diseño. Estos solo se utilizan para fines de interfaz de usuario.
El configlet asignado vive en https://aos-server/api/blueprints/blueprint_id/configlets
Sintaxis JSON para poner un configlet en un plano. Básicamente, este es solo un elemento de diccionario 'items' que contiene una lista de esquemas de configuración.
{
"items": [
{
"template_params": [
"string"
],
"configlet": {
"generators": [
{
"config_style": "string",
"template_text": "string",
"negation_template_text": "string"
}
],
"section": "string",
"display_name": "string"
},
"condition": "string"
}
]
}
Ejemplo de CURL: HTTP PUT
curl "http://aos-server/api/blueprints/e4068e99-813c-4290-b7cc-e145d85a98a8/configlets" -X PUT -H "AuthToken: EXAMPLE" -H "Content-Type: application/json; charset=utf-8" --data "[{""configlet"":{""generators"":[{""config_style"":""eos"",""template_text"":""ip name-server 192.168.1.1"",""negation_template_text"":""no ip name-server 192.168.1.1""}],""section"":""system"",""display_name"":""DNS""},""condition"":""role==spine""},{""configlet"":{""generators"":[{""config_style"":""eos"",""template_text"":""ip name-server 192.168.1.1"",""negation_template_text"":""no ip name-server 192.168.1.1""}],""section"":""system"",""display_name"":""DNS""},""condition"":""role==leaf""}]"
Respuesta
{"items": [{"configlet": {"generators": [{"config_style": "eos", "template_text": "ip name-server 192.168.1.1", "negation_template_text": "no ip name-server 192.168.1.1"}], "section": "system", "display_name": "DNS"}, "condition": "role==spine"}, {"configlet": {"generators": [{"config_style": "eos", "template_text": "ip name-server 192.168.1.1", "negation_template_text": "no ip name-server 192.168.1.1"}], "section": "system", "display_name": "DNS"}, "condition": "role==leaf"}]}
API: Configuración sin asignar
Para desasignar un configlet, elimínelo de la lista de elementos mediante PUT con una publicación json vacía.
curl "http://aos-server/api/blueprints/e4068e99-813c-4290-b7cc-e145d85a98a8/configlets" -X PUT -H "AuthToken: EXAMPLE" -H "Content-Type: application/json; charset=utf-8" --data ""
La respuesta es un conjunto json vacío una vez que se elimina el configlet: {"items": []}