Cloud scripts and cloud script templates
Summarize
Summary of Cloud scripts and cloud script templates
Within the Cloud Provisioning and Governance application of ServiceNow, script execution is categorized into cloud scripts and cloud script templates. These scripts are integral to automating and customizing provisioning processes, such as in blueprints, resource blocks, OS profiles, and request form policies.
Show less
Cloud Scripts
Cloud scripts are JavaScript-based scripts leveraging ServiceNow platform features. They use parameters comprising names, default values, and override values to dynamically control behavior. Scripts typically access a built-in templateResolver object to fetch and process cloud script templates by name, passing parameter values for runtime customization.
Example use cases include modifying parameter values programmatically before template execution and querying custom tables to influence script output. Cloud scripts cannot override user data in policy scripts.
Cloud Script Templates
Cloud script templates represent the actual executable scripts that run on target virtual machines. These templates can be in various formats such as Shell, PowerShell, or CloudInit scripts, depending on the VM execution environment. Templates must be created first and then linked to cloud scripts for execution.
Cloud Scripts as CloudInit
ServiceNow supports specifying CloudInit scripts at multiple levels to automate VM boot-time configuration:
- Image level: Associate a cloud script with a specific VM image so it runs automatically when that image is provisioned.
- OS profile level: Map cloud scripts to OS profiles irrespective of the underlying image or target a specific cloud provider and AMI/image. OS profile mappings override image-level associations.
- Resource blocks: Control execution of cloud scripts within blueprints by linking scripts to resource blocks and resource aliases.
Cloud Scripts as Postinit
Cloud scripts can also serve as Postinit scripts executed after VM provisioning within resource blocks. Using the ExecuteScript operation, you can select and run a cloud script and override its parameters with JSON maps. This allows flexible scripting for post-provisioning customization.
Practical Benefits for ServiceNow Customers
- Automate and customize VM provisioning workflows with dynamic script execution.
- Use parameterized scripts and templates for reusable and adaptable automation.
- Leverage multi-level script associations (image, OS profile, resource block) for precise control over provisioning behaviors.
- Enhance VM boot-time configuration through CloudInit scripts tied directly to ServiceNow images and OS profiles.
- Execute post-provisioning scripts to finalize configurations or integrate with other processes.
In the Cloud Provisioning and Governance application, script execution is divided into cloud scripts and cloud script templates. Use scripts in blueprints, resource blocks, OS profiles, and use policy scripts to set request form attributes. Policy scripts cannot override user data.
Cloud scripts
function evaluateTemplate() {
// Template Resolver is a helper function which we will use to fetch a template and replace its parameters,
// var templateResolver=new TemplateResolver(); this comes inbuild
// templateAttributes below will passed from the user.
var listDir=templateResolver.getTemplate('Install',templateAttributes);
return listDir;
}
Each cloud script contains certain parameters. Parameters are the attributes that you want to access. A parameter contains a name, a default value, and an override value. The default value can be a string literal, a resource block parameter or a complex script expression used in resource blocks.
A cloud script, by default, has access to the templateResolver object. The templateResolver object has, by default, a getTemplate method, whose first parameter is the cloud script template name. templateAttributes are the cloud script parameters created as part of a cloud script. If needed, customizations can be done in templateAttributes. As an example, see the following code snippet if the value of DevName parameter needs to be changed from John to Emily.
function evaluateTemplate() {
// Template Resolver is a helper function which we will use to fetch a template and replace its parameters,
// var templateResolver=new TemplateResolver(); this comes inbuild
// templateAttributes below will passed from the user.
templateAttributes['DevName'] = 'Emily';
var customNodeName;
var now_GR = new GlideRecord('some_custom_table_to_query');
gr.addQuery('some_parameter','some_value');
gr.query();
if(gr.next())
customNodeName=gr.getValue('some_custom_node_name');
templateAttributes['NodeName'] = customNodeName;
var listDir=templateResolver.getTemplate('Install',templateAttributes);
return listDir;
}
evaluateTemplate();
Cloud script templates
Cloud script templates are actual executables which are passed to target a virtual machine for execution. Cloud templates can be of any type (Shell/PowerShell/CloudInit) depending on the execution context. You need to create a cloud template first and then associate it with a cloud script.
Cloud scripts as CloudInit
- Image level: At the time of creating a cloud script, you can specify an image against
which this script should be executed. Once an OS profile which contains this specific
image gets selected, the default cloud script against this image is executed. In the
example below, an Apache cloud script is associated with a particular image.
- OS profile level: You can run a cloudinit against a specific cloud provider and
against a specific AMI/image. You can also be generic and associate a cloudinit to an OS
profile, irrespective of the underlying image. In the following example, multiple images
are associated with the OS profile. You can map any cloud script to the OS profile in
the Cloud Script OS Profile Mappings tab. The mapping of a cloud script with an OS
profile takes precedence over the image-level cloud script association.
In this example, the Apache cloud script is mapped to the Centos OS profile. If needed, you can override the script parameters in the OS Profile Mapping Overrides section. - Resource blocks: While mapping a cloud script to an OS profile, you can choose whether to execute the cloud script for a specific resource block used in a blueprint and against a particular resource alias. See Create an OS profile.
Cloud scripts as Postinit
You can use cloud scripts as Postinit scripts in a resource block. Once you create a resource block with a virtual machine to be provisioned, you can add an ExecuteScript operation. The ExecuteScript operation takes a script parameter (a pool of cloud scripts) and you can select any script to execute. Use the ScriptParameters attribute in the ExecuteScript operation to override any script parameter. You can provide a JSON map of script parameter and its override value. All expressions that are supported by Cloud Management work in the ScriptParamters attribute.