Tutorial - Creating the Playbook

Stage 2 - High-Level Process

Description

Now we need to define the high-level process using a steps section.

Based on the Task Summary, here's what our task needs to do:

  • Display some welcome text
  • Get Active Directory connection details
  • Search for Active Directory user
  • Add the user to group(s)

A step can be created for each of these, with a clear & readable name.

Tip

Step names are used in PPA task logs, so well-named steps can aid troubleshooting!

Playbook Snippet

Steps

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
steps:

  - name: Display Welcome Text
    actions:

  - name: Get Domain Controller
    actions:

  - name: Search for User
    actions:

  - name: Add User to Group(s)
    actions:

The actions will be populated in the next tutorial step

Updated Playbook

The current Playbook after tutorial stages 1 & 2.

Validation

Don't worry if the current Playbook fails to validate in the PPA Task Builder.

We haven't defined the actions for each step yet, which is covered in the next stage.

Playbook Progress
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
metadata:
  name: Active Directory - Add User to Group(s)
  description: Add an Active Directory user to one or more groups.
  icon: active_directory
  tags:
    - user
    - group
    - active directory
  author: Osirium

steps:

  - name: Display Welcome Text
    actions:

  - name: Get Domain Controller
    actions:

  - name: Search for User
    actions:

  - name: Add User to Group(s)
    actions: