Process:
- Create a new V5 Runbook.
- Manually migrate the task's content from your old Runbook to the new Runbook.
- For Instruction tasks: Copy and paste the content and re upload images
- For Input tasks: Re-create the inputs
- For Automation tasks:
- For an Automation Task without inputs and outputs: Simply copy the script content and save.
- For an Automation Task with inputs and outputs:
- Determine what the inputs and outputs are
- Add MSPC parsing directives according to Syntax for declaring inputs and outputs (see ‘Appendix A’ below)
- Update the script
- Bind the inputs and outputs using the MSPC UI
- Publish the Runbook.
- Test the Runbook.
APPENDIX A - MSPC syntax for declaring inputs and outputs
This appendix describes the syntax for declaring inputs and outputs in MSPComplete automation tasks and scripts.
Example:
Endpoint Input
#mspc-input name=MyEndpoint type=endpoint required=true
String output
#mspc-output name=Result type=string
Input / Output Declaration
Table below described the syntax of input and output declarations.
MSPC Keyword | Argument Name | Argument Value | Description | Example |
#mspc-input | name= | Alphanumeric string. Allowed characters: a-z, A-Z, 0-9, dash - and underscore _ | Defines the variable name inside the script for input |
name=myVariable name=internal_01 |
type= | Case-insensitive, alphanumeric string. Allowed characters: a-z, A-Z, 0-9 and square brackets [] | Defines the variable type and the cardinality of the variable. The square brackets [] denotes Multiple cardinality of the variable. Full list of the types is below | type=string type=STRING type=enduser[] type=EndUser[] |
|
required= | Allowed values: true, false. Default to false |
Defines whether the input variable is required | required=true required=false |
|
#mspc-output | name= | Alphanumeric string. Allowed characters: a-z, A-Z, 0-9, dash - and underscore _ | Defines the variable name inside the script for input | name=myVariable name=internal_01 |
type= | Case-insensitive, alphanumeric string. Allowed characters: a-z, A-Z, 0-9 and square brackets [] | Defines the variable type and the cardinality of the variable. The square brackets [] denotes Multiple cardinality of the variable. Full list of the types is below | type=string type=STRING type=enduser[] type=EndUser[] |
|
required= | Allowed values: true, false. Default to false |
Defines whether the input variable is required | required=true required=false |
Supported types
The full list of currently supported variable types:
Simple types
Type | PowerShell Type | Comments |
activeDirectoryForest | string | |
bool | bool | |
dateTime | DateTime | |
domain | string | |
emailAddress | string | |
guid | Guid | |
int | long | |
mailboxQuota | long | |
percentage | double | |
phoneNumber | string | |
secureString | string | |
string | string |
MSPComplete entity reference types
Type | Comments |
computer | |
customer | |
device | |
endpoint | |
endUser | |
gateway | |
group | |
microsoftAzureRegion | |
proxyJob | |
resource | |
server | |
virtualMachine |