Contents


Network Automation Guide

Legal notice

Contents

About this document

Part I. NSP Network Automation

1. Network automation in NSP

Network Automation functions

What does this guide cover?

Part II. Artifacts

2. Artifact management

Artifact support

What is artifact support in NSP?

Artifact bundles

What is an artifact bundle?

How do I install an artifact bundle?

How do I view artifact bundle contents?

How do I uninstall an artifact bundle?

Artifacts

What is an artifact?

Version management

What is automatic reconcile of artifacts?

How do I retry a failed artifact operation?

How do I edit or delete an artifact?

How do I roll back an artifact version?

Part III. SDK Application

3. SDK

What is the SDK?

How do I install the SDK?

How do I backup the SDK?

How do I restore the SDK?

Working with the SDK

How do I start the SDK application?

How do I generate a key and a certificate?

Code-Server

Web Proxy

Part IV. Network Intents

4. Intent types

Overview

What are intent types?

What are the components of an intent type?

What is a composite intent type?

What is an intent type version?

What is intent dependency?

What are intent type states?

Intent type procedures

How do I create an intent type?

How do I import an intent type from my computer?

How do I clone an intent type?

How do I edit an intent type?

How do I add or change a View file?

How do I delete an intent type?

How do I change the state of an intent type?

How do I create a new version of an intent type?

How do I export an intent type or its view files?

How do I configure user access to an intent type?

5. Intents

Overview

What is an intent?

What is a network state?

What is an intent audit?

What is the difference between synchronize and reconcile?

What are approved misalignments?

Procedures

How do I create an intent?

How do I view intents?

How do I modify an intent?

How do I audit an intent?

How do I approve misalignments?

How do I modify approved misalignments?

How do I migrate an intent?

How do I execute an action from an intent?

6. Intent Policies

What is a policy?

How do I create an intent policy?

How do I trigger a policy?

What is a policy action?

7. Mediators

What is a mediator?

What mediators are available?

How do I edit a mediator?

How do I delete a mediator?

Part V. Workflows

8. Workflows

Overview

9. Using workflows

What is a workflow?

How do I add a workflow?

How do I create a workflow?

How do I import files from my computer?

How do I export files?

How can I interact with the Nokia Git repository from NSP?

How do I clone a workflow?

How do I edit a workflow?

How do I update an input form?

How do I change the status of a workflow?

How do I execute a workflow?

What is a flow?

How do I configure user access to a workflow?

10. Actions and action executions

Overview

How do I create an adhoc action?

How do I create an action execution?

11. Environments

What is an environment?

How do I create an environment?

How do I clone an environment?

How do I modify an environment?

12. Jinja2 templates

What is a Jinja2 template?

How do I create a Jinja2 template?

How do I clone a Jinja2 template?

How do I edit a Jinja2 template?

13. Workflow executions

What is a workflow execution?

How do I rerun a workflow execution?

How do I update the description of a workflow execution?

How do I stop a workflow execution?

How do I change the state of a running or failed workflow execution?

How do I evaluate a YAQL expression?

How do I debug an action?

14. Kafka triggers

What is a Kafka trigger?

How do I create a Kafka trigger?

How do I edit a Kafka trigger?

15. Schedules

What is a schedule?

How do I schedule a workflow?

16. Workflow policies

What is a workflow policy?

How do I create a workflow execution cleanup policy?

How do I edit a policy?

Part VI. Network Automation use cases

17. Network intent use cases

Creating an intent

18. Workflow use cases

Importing and executing a workflow from Git to NSP