Configuration de StyleBook

Utiliser des API pour importer des StyleBooks personnalisés

Utilisez l’API StyleBook pour importer des StyleBooks personnalisés dans la console NetScaler. Utilisez les API REST pour créer un pack de configuration à partir de ce StyleBook dans n’importe quel outil tel que l’outil de ligne de commande cURL ou l’extension de navigateur Postman Chrome. Par exemple, vous pouvez importer un StyleBook nommé example-lb qui peut être utilisé pour créer une configuration d’équilibreur de charge sur une instance NetScaler.

Méthode HTTP : POST

URL : https://<ADM-endpoint-name>/stylebook/nitro/v2/config/stylebooks/actions/import?mode=async

{
    "import": {
        "file_name": "add_dnssoarec.yaml",
        "source": "<base 64 encoded content of the sb definition>",
        "encoding": "base64"
    }
}
<!--NeedCopy-->

Où, la valeur de source l’attribut est le codage base64 du contenu de votre fichier StyleBook. Vous pouvez coller le contenu YAML de votre fichier StyleBook dans un outil en ligne. Par exemple, utilisez https://www.browserling.com/tools/file-to-base64 pour obtenir la chaîne base64 que vous pouvez ensuite utiliser comme valeur pour l’ source attribut.

À l’aide de cet appel d’API, vous pouvez également télécharger un fichier tarball compressé (fichier .tgz) contenant plusieurs fichiers StyleBook dans une seule opération d’API. Procédez comme suit :

  • Remplacez l’ file_name attribut par le fichier .tgz
  • Remplacez l’ source attribut par le codage base64 du contenu de votre fichier .tgz

Une fois l’API exécutée avec succès dans l’outil, vous obtenez une réponse avec un identifiant de tâche. Utilisez cet ID de tâche pour suivre l’opération jusqu’à son achèvement :

200 ACCEPTED
<!--NeedCopy-->

Corps de réponse :

{
    "job": {
        "job_id": "12345678"
    }
}
<!--NeedCopy-->

Utilisez le Job ID pour suivre l’état de l’opération :

Méthode HTTP : GET

URL : https://<ADM-endpoint-name>/stylebook/nitro/v2/config/jobs/<job-id>

Le statut de la tâche est renvoyé :

200 OK
<!--NeedCopy-->

Corps de réponse :

{
    "job": {
        "job_id": "<job-id>",
        "progress_info": [
            {
                "is_last": "true",
                "message": "No job found",
                "status": "failed"
            }
        ],
        "status": "completed"
    }
}
<!--NeedCopy-->

La valeur d’état « terminé » indique que le StyleBook a été importé avec succès. Confirmez l’état des opérations en obtenant des informations sur le StyleBook :

Méthode HTTP : GET

URL : https://<ADM-endpoint-name>/stylebook/nitro/v2/config/stylebooks/samples/1.0/demo-helper-object

Les détails du StyleBook importé s’affichent :

200 OK
<!--NeedCopy-->

Corps de réponse :

{
    "stylebook": {
        "builtin_namespaces": {},
        "created_datetime": "2023-01-14 00:13:59",
        "custom": true,
        "dependencies": [],
        "deprecate": "false",
        "description": "This Stylebook is a test",
        "display_name": "Test StyleBooks",
        "encoding": "BASE64",
        "header": "Test StyleBooks",
        "icon": "''",
        "id": "demo575731aacbfc20b4ff00b3b60ea59855",
        "is_updatable": true,
        "name": "demo-helper-object",
        "namespace": "samples",
        "primary_keys": {},
        "private": false,
        "repository_name": "",
        "reverse_dependencies": [],
        "schema_version": "1.0",
        "source": "<base 64 encoded content of the stylebook definition>",
        "tenant_id": "1a45fd70-7ce3-4bff-8642-1bd7f7e97673",
        "username": "abc",
        "version": "1.0"
    }
}
<!--NeedCopy-->
Utiliser des API pour importer des StyleBooks personnalisés

Dans cet article