- 23 Oct 2024
-
DarkLight
-
PDF
Description Field
- Updated on 23 Oct 2024
-
DarkLight
-
PDF
Using the Description Field
The Description field is a new feature in Itential Automation Gateway (IAG) designed to maintain and manage a persistent description of Roles, Playbooks, and Scripts.
The Description field can be modified and used for any descriptive purpose, such as what a Role, Playbook, or Script is used for, how it is being used, and in what capacity (i.e., use case). It is also a way to help with knowledge transfer for users who are learning about the use of Roles, Playbooks, and Scripts by providing a summary of information beyond just a name or title that communicates important attributes or metadata.
Editing the Description Field
In the example below (Figure 1) a Playbook is used to illustrate how to access the Description field.
Step | Action |
---|---|
1 | Select the Playbook from the left side navigation menu. |
2 | Click the Gear icon in the upper-right corner of the canvas. |
3 | Add the descriptive text in the Description field. Click the Save button. |
4 | Click the Edit icon (pencil) under the Parameters heading to modify the descriptive text in the Description field. |
Figure 1: Description Field
Description Field Examples
Below are code snippet examples showing the Description field for Playbooks, Roles, and Scripts as a metadata key value.
Playbooks
This code sample shows the "description"
field for Playbooks.
{
"properties": {
"SPECIFY_PROP_NAME_HERE": {
"type": "string",
"description": "INSERT DESCRIPTION HERE"
}
},
"required": [],
"metadata": {
"description": ""
}
}
Roles
This code sample shows the "description"
field for Roles.
{
"properties": {},
"required": [],
"metadata": {
"description": ""
}
}
Scripts
This code sample shows the "description"
field for Scripts.
{
"properties": {
"argument_list": {
"type": "array",
"description": "Array of arguments to be passed to the script",
"items": {
"type": "string"
}
},
"env_vars": {
"type": "object",
"description": "Object containing environment variables to be passed to script",
"properties": {
"env_list": {
"type": "array",
"description": "Array of environment variable 'name=value' pairs for script",
"items": {
"type": "string"
}
}
}
}
},
"script_argument_order": [
"argument_list"
],
"metadata": {
"description": ""
}
}