Fields on the Script Packages page

Use the Script Packages page to manage script packages in the catalog.

The Script Packages list

The Script Packages page displays the list of script packages that are currently available in the catalog, including any default script packages that are provided with the product and any additional script packages that you or other users created. The following functions are available for you to work with the list of script packages:

Refresh: Refreshes the status of the script packages and updates the fields on the Script Packages page.
Create New: Click Create New to create a new script package.
Filter: Enter a term that is used to filter the script packages that display on the page.
Entire Domain: Click Entire Domain to view all script packages that you have permission to view across all systems in a multisystem management domain. The Locations column displays the number of systems in the domain that contain each script package. Click the number in the column to view the systems that contain the script package in the Locations window.
Note: Only valid for external (LDAP) users.
Subdomain Only: Click Subdomain Only to view all script packages that you have permission to view across the systems in a multisystem deployment subdomain. The Locations column displays the number of systems in the subdomain that contain each script package. Click the number in the column to view the systems that contain the script package in the Locations window.
Note: Only valid for external (LDAP) users.
Local Only: Click Local Only to view all script packages that you have permission to view on this system.
Note: Only valid for external (LDAP) users.

To work with a script package, select it by clicking the name in the list or click Show Details in the Actions column. Details about the selected script package are displayed in a slide-out pane.

Icons in the Actions column

The Actions column of the Script Packages page includes the following additional icons:

Clone: Creates a copy of the script package, even a locked (read-only) script package, that can be edited. If there are outstanding license agreements for the script package that are not accepted, this icon is not available.
Lock: Configures the script package as read-only and locks it to prevent further editing.
Export: Exports the script package for use on another system.
Show Details: Shows the details for the script package in a slide-out page.

Details on the selected script package

Selecting a script package displays the name of the script package in the toolbar at the top of the page and details about the script package.

Details about the selected script package are displayed in the following fields:

Locations

Shows the location of copies for the script package on other systems for the external (LDAP) user in a multisystem environment. The following functions are available for you to work with the copies:

Copy to location: Copies the artifact to a remote system.
Sync changes: Synchronizes the artifact on the system with the local system.

The absence of either function indicates that the artifacts at two locations are identical and synchronized, or that the script package does not contain a script package file.

Note: The attributes that are compared to determine whether there are differences between script packages at different locations are license status and the access control list.

Description

An optional text description of the script package. You can edit this description to provide meaningful information about the script package.

Version

The version of the selected script package.

Created on

The date and time that the script package was created. This value is stored internally as the number of seconds since midnight January 1, 1970 Coordinated Universal Time. This value is displayed as the equivalent date and time in the local timezone.

Current status

The status of the script package can be one of the following status types:

Draft: You can modify the script package.
Read-only: The script package is locked and cannot be modified.
License not accepted: The script package has one or more license agreements that are not accepted.

Updated on

The date and time that the script package was last updated. This value is stored internally as the number of seconds since midnight, January 1, 1970 Coordinated Universal Time. The value is displayed as the equivalent date and time in the local timezone.

Operating system

The type of operating system for which this script is supported. This parameter is useful when you need to indicate that the script is valid only for a specific operating system.

License agreement

Indicates whether there are any license agreements in the script package, and whether they are all accepted. If there are no license agreements to be accepted, the License agreement section of the Script Packages page displays a status of None provided.

If one or more license agreements are not yet accepted, you can click the accept link, which displays the list of license agreements that you must accept as needed. For each license agreement, click the associated link to display the terms and conditions, review it carefully and then click Accept to accept the agreement or click Cancel to close the license agreement display without accepting.

After you accept all license agreements for the script package, the License agreement section of the Script Packages page displays a status of Accepted. You can click the accompanying view link to view the license agreements as needed.

You must accept all license agreements before you can include the script package in a virtual system pattern or deploy a virtual system pattern that contains this script package. For more information about accepting license agreements, see the related links.

Script package file

The name of the archive file that contains the main executable file, and all associated artifacts that support the execution of the main executable file, for this script package. This file is uploaded when the script package is created. Use the download link to save a copy of this file.

To replace an existing compressed file in the script package, complete the following steps:

Click Browse in the field and go to the location of your compressed file and select it. The name of the compressed file is displayed in the Script package file field.
Click Upload to upload the selected compressed file into the script package.

Note:

You cannot replace the compressed file for a script package that is read only.
When you replace the compressed file for a script package, if the name or version in the new compressed file do not match the current script package name and version, a warning is displayed. You can proceed with the import or cancel. If you proceed, the existing name and version are kept, and the name and version in the new archive are ignored.

Product IDs

Specifies license information for the script package, including the product ID associated with the license, as represented in the license catalog, and the type of license.

Environment

Defines a set of environment variables that are available when the script package is run on its target virtual system instance. The environment variables are a set of key and value pairs that are defined to the run time environment of the script package.

The system supplies a set of environment entries for you. For more information about predefined environment variables, see the related links.

If your script package includes a cbscript.json object file, environment variables and their values that are defined in that file are also displayed in this section.

In this section, you can specify more environment variables that are specific to your deployment:

In the Add variable fields, specify the key name and the value for the environment variable.
Click Add to add the key and value pair to the list of environment variables for the script package.

Note: Each environment variable is defined by a set of attributes, including the required attribute, which indicates whether the environment variable value is required or optional when the script package is deployed in a pattern. When you add an environment variable to your script package by using this Add variable field, it is defined by default as a required variable.

If you have an existing environment variable that was included in the uploaded cbscript.json object file, the environment variable might be defined as either required or optional. If you add an environment variable of the same name as an existing optional variable, the variable is replaced and is changed from an optional variable to a required variable.

To define a required variable as an optional variable, you must download the compressed file and modify the environment variable attributes in the cbscript.json object file, then upload the modified compressed file into the script package again to see the environment variables in the Script Packages page.

Repeat this process to add more environment variables to the script package.

If you have environment variables defined that you want to remove, click Remove next to the key and value pair.

If you have a number of environment variables that are defined in this section, use the show more and show less links to display more or less variables as needed.

If you are viewing a script package that is read-only, any defined environment variables are displayed, but cannot be modified.

When this script package is later added to a virtual system pattern and deployed, some environment variables can be modified as needed by users who have access to the pattern.

Working directory

The directory, on the target virtual machine, into which files for this script package are to be extracted. The working directory is also the initial current working directory when the script is run. The default value is /tmp, but the best practice is to specify a new directory under /tmp, for example, /tmp/myscriptdir.

Important: The script architecture assumes that every script is run from its own private directory, usually under the /tmp directory.

After the script completes, the system makes a list of all of the files under its working directory and its subdirectories that do not have the suffix .rpm, .tgz, .gz, .zip, .exe, .BIN, or .bin. The files that are in this list are included in the script_log.zip file.

Logging directory

The directory, on the target virtual machine, that is to contain the log files that are generated by the execution of the script package. You can view these logs from either the product console or by directly accessing them on the virtual machine.

Executable

The command to be run for this script package. You can specify any command on the virtual machine (for example, wsadmin, tar, ant, or another system command). You can also provide your own script to be run as part of the script package.

Arguments

One or more parameters that are passed to the executable command. You can optionally specify environment variables and other valid command-line syntax. You can also access the environment by using standard techniques (for example, shell or ant).

Timeout

The maximum amount of time to wait for the script to finish running on a virtual machine. Specify the timeout as the number of milliseconds to wait, or 0 to wait indefinitely for the script to complete. The default value is 60000000.

Executes

Specifies when the script package is run on the system. The default behavior is for the script package to run after all the virtual machines are successfully started and all the nodes are federated, where applicable. The default behavior occurs when the virtual system instance is created. The following values are valid for this parameter:

at virtual system instance creation: Specifies that the script is run when the virtual system is finished starting during the initial creation.
at virtual system instance deletion: Specifies that the script is run when the virtual system is deleted.
Important: Scripts that run when a virtual system instance is deleted are run only if the virtual system instance is running when it is deleted.
when I initiate it: Specifies that the script is started manually by using the start icon that is displayed next to the script name for a virtual machine. Click the icon to run the script. There is no limit on the number of times that you can run a script by using this method.
at virtual system creation and when I initiate it: Specifies that the script is run when the virtual system is finished starting during the initial creation, and is also available to be started manually by using the start icon that is displayed next to the script name for a virtual machine. Click the icon to run the script. There is no limit on the number of times that you can run a script by using this method.

Run in parallel

For virtual system instances with more than one virtual machine, specifies whether the script package is run in parallel rather than in sequence.

If this attribute is set to Yes, the script package is run in parallel, and starts on all virtual machines in the virtual system instance at the same time.

If this attribute is set to No, the behavior defaults to rolling, which means that the script package starts on one virtual machine in the virtual system instance. The script package is not started on the next virtual machine in the virtual system instance until it is finished running on the first virtual machine. The script package starts on the next virtual machine in the virtual system instance regardless of whether the previous script completed successfully or failed.

Reboot after execution

If this attribute is present and set to true, the virtual machine restarts after the script package runs.

Save environment variables after post-deployment executions

Indicates whether any changes that are made to script parameters are persisted and applied to a deployed script package on subsequent executions.

Yes: Changes made to script package parameter values after deployment are persisted. On subsequent runs of the script package, the most recent updates to script package parameter values are used instead of the configuration that was in effect at the time of deployment. This setting affects all instances of the script. Each use of the script in a deployment pattern has its own copy of the script parameter values.
No: Changes made to script package parameter values after deployment are not persisted. On subsequent runs of the script package, the parameter values that were applied at the time of deployment are presented, and you must manually change these values as needed each time that you run the script package.

For more information about this configuration setting in the extendedattributes.json file, see the related links.

Included in patterns

The list of virtual system patterns to which this script package is already added. Each virtual system pattern name is a link that can be clicked to view the pattern. This field is initially blank.

For more information about working with virtual system patterns, see the related links.

In the cloud now

The list of virtual system instances that contain this script package.

Access granted to

The access control list for this script package. Users or groups who have access to this script package are listed in the field as links. Access is automatically granted to the user that creates the script package. If you have permission, use the Add more entry field to provide access for more users or groups of users. For each user or group of users in this list, you can specify whether they have read, write, or all access by clicking the link next to the user or group name. Click remove to remove the user or group from the access list. This script package can be included in virtual system patterns that are created by these users and groups. If extra users or user groups require access to the script package, they must be added manually.

Note: As the signed-in user, you must be assigned Workload resources administration > Manage workload resources (Full permission) to add other user groups to the script package.

Comments

Lists any text comments that were added to provide additional information about this script package. Comments are listed by the date and time the comment was added. You can add a comment by typing your text in the space that is provided and clicking Add Comment. After comments are added, they cannot be removed.