Running Playbooks

On the “Playbooks” page, you can see the list of playbooks that are created. You can add or import a playbook, check syntax for a playbook, or run a playbook as needed.

In addition, AmpCon-Campus provides multiple playbook management functions including copying playbooks, using pre-built playbooks, editing, deleting, copying, or exporting playbooks, and adding tags to playbooks.

1 Adding a Playbook
2 Importing a Playbook
3 Running a Playbook
4 Optional: Checking Syntax for a Playbook
5 Optional: Using Pre-built Playbooks
6 Optional: Editing a Playbook
7 Optional: Deleting a Playbook
8 Optional: Copying a Playbook
9 Optional: Exporting a Playbook
10 Optional: Adding or removing Tags to a Playbook

Adding a Playbook

Click Maintain > Automation > Playbooks in the AmpCon-Campus UI.
On the “Playbooks” page, click Playbook.
Enter the playbook name and description (optional). Click playbook.yml, and add contents to the .yml file. You can also add files or folders to the playbook.

Click Save All.

Importing a Playbook

Click Maintain > Automation > Playbooks in the AmpCon-Campus UI.
On the “Playbooks” page, click Import.
Enter the playbook name and description (optional), and upload the playbook .zip file.

Click Import.

Running a Playbook

Click Maintain > Automation > Playbooks in the AmpCon-Campus UI.
On the “Playbooks” page, locate a playbook, and then click Run.
Select the playbook.yml file, and then click Next.

Select target switches to run the playbook by using the following ways:

Note: If you select switches, groups, and other devices in the Choose Switches, Choose Groups, and Choose Other Devices tabs, the playbook will be run on all selected targets.

Choose switches

In the Choose Switches tab, select one or multiple switches.

Choose groups

In the Choose Groups tab, select one or multiple groups.

Choose other devices

In the Choose Other Devices tab, select one or multiple devices that you added in Adding Other Devices.

Click Next.
Enter extra variables if needed, and then click Next.

Select the schedule type to run the playbook.

Run Now: Executes the task immediately upon creation
One Time: Executes the task within the selected time range after creation
Scheduled: Executes the task periodically after creation

Click Run Playbook.

Optional: Checking Syntax for a Playbook

On the “Playbooks” page, locate a playbook, and then click Check. A message pops up with the checking result.

Optional: Using Pre-built Playbooks

AmpCon-Campus provides multiple pre-built playbooks, which are hidden by default.

Note: Pre-built playbooks can’t be run directly. You need to click Save As to copy a pre-build playbook as a new playbook and then run the new playbook. You can’t edit or remove pre-built playbooks. And you can’t add tags or check syntax for pre-built playbooks.

To show the pre-built playbooks, click the Show Pre-built Playbooks toggle on the “Playbooks” page.

To view a pre-built playbook, locate the playbook, and then click View.

To refresh the pre-built playbook list, click Update Pre-built Playbooks.

To export a pre-built playbook, locate the playbook, and then click Export.

Optional: Editing a Playbook

On the “Playbooks” page, locate a playbook, and then click Edit. Modify the playbook contents as needed. You can also add or remove folders and files. Then, click Save All.

Optional: Deleting a Playbook

On the “Playbooks” page, locate a playbook, and then click Remove. Then, click Yes to confirm the deletion.

Optional: Copying a Playbook

On the “Playbooks” page, locate a playbook, and then click Save As. The new playbook has a default name, which you can modify as needed. Then, click Save.

Optional: Exporting a Playbook

On the “Playbooks” page, locate a playbook, and then click Export.

Optional: Adding or removing Tags to a Playbook

On the “Playbooks” page, locate a playbook, and then click Tag Management. Enter the tag name in the Tag Name field, and then click Add.

You can remove a tag by clicking the removal icon.