This section explains the format of script list files and how to write parameters in them.
Script Lists for L-Platform Templates
This section explains script lists (for setup and for operations) of rulesets used in L-Platform templates.
[Script Path]Script Name[,cmd=Script Command file Name][,node=none|Network Device Name][,group=Group Number][,param=(Parameter Name1=Parameter Value1,Parameter Name2=Parameter Value2, ...)] |
Script lists for setup and script lists for operations use the same format.
This section explains each item.
Specify the folder path for the script to execute using an absolute path or relative path from the scripts folder.
If you do not specify this path, the path of the script to execute is regarded as being the folder path including the script list.
Specify the name of the script you want to execute.
Do not specify a script list name in this field.
If you specify one, it is regarded as designating the execution script name.
Specify the name of the script command file you want to execute.
The value specified for this operand will be configured for the reserved variable "command file name".
If you invoke some command files, use the "command file name" with a serial number (in ascending order from 1) in the script.
If you do not specify the command file name in the script, the command file is not invoked from the script.
If you want to unconditionally execute the script regardless of the existence or status of network devices (firewalls or server load balancers), specify "none" for this operand.
When executing scripts specifying the specific network device (firewall or server load balancer), specify the name of the network device for this operand.
When specifying the network device name using something other than the script list for configuration (create.lst), specify the network device in the script list for configuration (create.lst).
When specifying the network device name in a redundancy configuration, specify all network device names in the same group (in the script line with the same group number) for this operand in the respective script lines.
When this operand is omitted, an available network device is automatically selected from an available network pool. Automatic selection of network devices is decided by specifying this operand in the script list for configuration (create.lst) used when creating an L-Platform.
When a network device is automatically configured while creating an L-Platform, after that, the same network device which was automatically selected is used even when executing scripts other than the script list for configuration (create.lst) for the same L-Platform.
If you execute a script for redundant network devices, set a group number between 1 and 99. This number is used to distinguish network devices in the same redundant configuration.
If there are 2 lines in a script with the same group number, then an available pair of network devices will be selected from the network pool.
(If there are no redundant network devices (at least one device in a pair is alive) available in a network pool, a script list execution error occurs due to the lack of available network devices).
If you want to change the configuration values of variable parameters in a parameter file per script list line, specify this operand.
Specify all parameter names and changed parameter values that you want to change.
If infrastructure administrators want to decide parameter values per script, writing parameters and their values at this operand means those variable parameters do not have fixed values in scripts.
If tenant users or administrators specify these parameters when creating an L-Platform, the parameter values are used in the script.
Information
Specified parameters are separated by "," and blank spaces between parameters and "," are ignored.
The number of lines specified in a script list is limited to 100, excluding comment lines.
Comments begin with "#" in the first column. Any characters can be used in the comment line.
Write comments such as description of executed scripts when necessary.
Comments are ignored when script lists are processed.
Blank lines are regarded as comments and ignored when a script list is processed.
Scripts in a script list are executed in the defined order.
Script lists are executed in the order of the list.
[Script Path]Script Name1,group=1[,cmd=Command File Name1] |
Script List for Network Resources
This section explains the ruleset script list used by network resources.
Script Path Script Name[,cmd=Script Command File Name],node=Network Device Name[,paramfile=Parameter File Name][,param=(Parameter Name1=Parameter Value1,Parameter Name2=Parameter Value2, ...)] |
This section explains each item.
Specify the folder path for the script to execute using an absolute path or relative path from the scripts folder.
The folder path, including the execution script, is necessary.
Specify the name of the script you want to execute.
Do not specify a script list name in this field. If you specify it, it is regarded as designating the name of the script to execute.
Specify the name of the script command file you want to execute.
The value specified for this operand will be configured for the reserved variable "command file name".
If you invoke multiple command files, it is necessary to use the "command file names" including a serial number (in ascending order from 1).
If you do not specify the command file name in the script, the command file is not invoked from the script.
Specify the name of the network device to execute the script.
If you specify the wrong network device name in this field, an automatic configuration error or incorrect configuration occurs when the script is executed. Specify the network device name carefully.
Specify the parameter file name of the variable information passed to the script.
If you use variable information from a parameter file, specify the name of the parameter file.
If you want to change the settings of variable parameters in the parameter file specified for the "paramfile" field per line of script list, use this operand.
Specify all parameter names and changed parameter values that you want to change.
Information
Specified parameters are separated by "," and blank spaces between parameters and "," are ignored.
The number of lines specified in a script list is limited to 100, excluding comment lines.
Comments begin with "#" in the first column. Any characters can be used in the comment line.
Write comments such as description of executed scripts when necessary.
Comments are ignored when script lists are processed.
Blank lines are regarded as comments and ignored when a script list is processed.
When a script list processes the same network device, the script list is not executed at the same time but executed in order. On the other hand, when a script list does not process the same network device, the script list is executed at the same time.
Script lists are executed in the order of the list.
[Script Path]Script Name1,node=Network Device Name1,param=(Parameter Name1=Value,...) |
Differences Between Script Lists of L-Platform templates and Network Resources
This section explains the differences between script lists of L-Platform templates and network resources.
Item | Folders for L-Platform Templates | Folders for Network Resources |
node operand: | Network devices cannot be specified. The network device is automatically selected. "none" can be specified when the script is not related to the specified network device. | Can be specified |
group operand: | Can be specified | Cannot be specified |
paramfile operand: | Cannot be specified | Can be specified |
