Lumen help

Creating a PowerShell script task

Use the Edge Services portal to automate tasks using PowerShell script for your CentOS and Windows instances. PowerShell script is used for automating system management and for building, testing, and deploying solutions in CI/CD (Continuous Integration/Continuous Deployment) environments. PowerShell is built on the .NET CLR (Common Language Runtime). All inputs and outputs are .NET objects. This is System.Object in the .NET framework.

To use PowerShell script tasks, Windows PowerShell Tool must be installed on the OS (operating system) that is executing the script. Integrate a Git account into the Edge Services portal to store and access files in a repository for your tasks.

You can execute your automated task as a single task or combine it as part of an operational or provisioning workflow.

Note: Library tab functionality is only available for AWS (Amazon Web Services) and Azure cloud providers.

To create a PowerShell script task:

Click Library, click Automation, then click Tasks.

The Edge Services portal shows the tasks created for your organization.

Edge Services Manager Library automation tasks view

Click +Add.

The Edge Services portal shows the New Task window.

In the New Task window, complete the following fields:

Field	Description
NAME	Type a unique name for the PowerShell script task.
CODE	Type a unique code to identify the PowerShell script task.
TYPE	Select Powershell Script.
RESULT TYPE	Select one of the following options: None—Task results are not returned. Single Value—Task results are returned in a single string. Key/Value Pairs—Task results are returned in key=value format. JSON—Task results are returned in key pairs in JSON (JavaScript Object Notation) key:value format. JSON is a data interchange format that uses readable text to store and transmit data consisting of attribute-value pairs and arrays.
ELEVATED SHELL	To enable scripts to run with administrator privileges, select the checkbox.
SOURCE	Select one of the following options: Local—Directly write and apply PowerShell scripts through the task. Repository—Access the repository where PowerShell scripts are stored. This requires a Git account to be integrated with the Edge Services portal. URL—Access the URL path where PowerShell scripts are stored. Additional fields appear based on your selections.
CONTENT	Type PowerShell script in this area to directly create content for your instance.
REPOSITORY	Select the repository that contains the PowerShell script.
WORKING PATH	Type the Git repository file path where the PowerShell script is stored.
BRANCH/TAG	Type the branch or tag of the Git repository to access the stored PowerShell script. A repository branch is an area of the repository where code can be worked on but the changes are isolated from the original source. A repository tag is a version reference point of the respository at a given time.
URL	Type the URL to access where the shell scripts are stored.

In the Target Options section, complete the following fields:

Field	Description
EXECUTE TARGET	Select one of the following options: Local—Execute the task from a local provisioned instance. Remote—Execute the task from a remote server. Resource—Execute the task from a managed server or instance. Additional fields appear based on your selections.
IP ADDRESS	Type the IP address of the target executing the PowerShell script.
PORT	Type the IP address of the SSH (Secure Shell) port of the target executing the PowerShell script.
CREDENTIALS	Select one of the following options to enter credentials for a remote server: username and password—Create a new user to perform this task. username, password, and keypair—Create a new user to perform this task and apply a keypair private key to the user. username and keypair—Create a new user to perform this task and apply only a username and keypair private key to the user. Local Credentials—Use an existing user to perform this task. Additional fields appear based on your selection.
SECRET STORE	Select one of the following options: Internal—Use credentials that are internal to the remote server. External—Use credentials that are external to the remote server.
USERNAME	Type the username of the target that is executing the PowerShell script. If you selected Local Credentials in the CREDENTIALS field, type the local administrator username in this field.
PASSWORD	Type the password of the target that is executing the PowerShell script. If you selected Local Credentials in the CREDENTIALS field, type the local administrator password in this field.
PRIVATE KEY	Select the private key that was generated to access the server executing the PowerShell script.
KEY	Select the key that was generated to access the server executing the PowerShell script.

In the Execute Options section, complete the following fields:

Field	Description
RETRYABLE	Select this option to retry the task if it initially fails.
RETRY COUNT	Type the maximum number of attempts to retry the task if it initially fails.
RETRY DELAY	Type the amount of time (in seconds) the portal waits between retry attempts for the task.
ALLOW CUSTOM CONFIG	Select this option to enable a text field to add extra variables or specifications to the task. This field appears in the Advanced Options section in the Execute Task? window when you manually execute a specific task.