5.25
This topic provides information on how to create an application template programmatically.
In this topic:
POST /api/templates/
POST /api/templates/
Request Body
{
"name": "New Template",
"version_description": "",
"type": "regular",
"description": {
"text": "",
"visible": false
},
"published": true,
"widgets": [
{
"default_value": "",
"label": "Name",
"variable_name": "NAME",
"visible": true,
"editable": true,
"properties": [
{
"name": "id",
"value": "name"
},
{
"name": "enable",
"value": "true"
}
],
"tooltip": "Allows you to specify a more friendly name (note: name must be alphanumeric)"
},
{
"default_value": 0,
"label": "Duration",
"variable_name": "DURATION",
"visible": true,
"editable": true,
"properties": [
{
"name": "id",
"value": "duration"
},
{
"name": "enable",
"value": "true"
}
],
"tooltip": "The amount of time the job is expected to run for"
},
{
"default_value": "",
"label": "Job Arrays",
"variable_name": "arrays",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "arrays"
},
{
"name": "enable",
"value": "false"
},
{
"name": "start-value",
"value": "0"
},
{
"name": "end-value",
"value": "1"
},
{
"name": "start-variable",
"value": "STARTINDEX"
},
{
"name": "end-variable",
"value": "ENDINDEX"
}
]
},
{
"default_value": 0,
"label": "Delay Start By",
"variable_name": "ELIGIBLEDATE",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "eligibledate"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Declares the time after which the job is eligible for execution"
},
{
"default_value": "0",
"label": "User Priority",
"variable_name": "USERPRIORITY",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "priority"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines the priority of the job"
},
{
"default_value": "",
"label": "Submission Script",
"variable_name": "SCRIPT",
"visible": true,
"editable": true,
"properties": [
{
"name": "id",
"value": "script"
}
]
},
{
"default_value": "",
"label": "Account",
"variable_name": "ACCOUNT",
"visible": false,
"editable": true,
"properties": [
{
"name": "id",
"value": "account"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines the account associated with the job"
},
{
"default_value": "",
"label": "Queue / Class",
"variable_name": "DESTINATIONQUEUE",
"visible": false,
"editable": true,
"properties": [
{
"name": "id",
"value": "destinationQueue"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines the destination queue / class of the job"
},
{
"default_value": "",
"label": "Quality of Service",
"variable_name": "QOS",
"visible": false,
"editable": true,
"properties": [
{
"name": "id",
"value": "qos"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines the desired QoS for the job"
},
{
"default_value": "",
"label": "Number of Cores",
"variable_name": "NUMOFCORES",
"visible": true,
"editable": true,
"properties": [
{
"name": "id",
"value": "cpupernode"
},
{
"name": "totalamount",
"value": true
},
{
"name": "nodeswithcount",
"value": true
},
{
"name": "malleablecorecount",
"value": true
},
{
"name": "totalamount_editable",
"value": true
},
{
"name": "nodeswithcount_editable",
"value": true
},
{
"name": "malleablecorecount_editable",
"value": true
},
{
"name": "totalamount_visible_default",
"value": true
},
{
"name": "nodeswithcount_visible_default",
"value": false
},
{
"name": "malleablecorecount_visible_default",
"value": false
},
{
"name": "totalcores_default",
"value": "1"
},
{
"name": "totalnodes_default",
"value": "1"
},
{
"name": "corespernode_default",
"value": "1"
},
{
"name": "minimumcores_default",
"value": "1"
},
{
"name": "maximumcores_default",
"value": "2"
},
{
"name": "enable",
"value": "true"
}
],
"tooltip": "Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed"
},
{
"default_value": "",
"label": "Memory (GB)",
"variable_name": "MEMORYAMOUNT",
"visible": true,
"editable": true,
"properties": [
{
"name": "id",
"value": "memorypernode"
},
{
"name": "totalmemory",
"value": true
},
{
"name": "memorypercore",
"value": true
},
{
"name": "totalmemory_visible_default",
"value": false
},
{
"name": "memorypercore_visible_default",
"value": true
},
{
"name": "totalmemory_default",
"value": "0.50"
},
{
"name": "memorypercore_default",
"value": "0.50"
},
{
"name": "totalmemory_editable",
"value": true
},
{
"name": "memorypercore_editable",
"value": true
},
{
"name": "enable",
"value": "true"
}
],
"tooltip": "Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed"
},
{
"default_value": "linux",
"label": "Architecture",
"variable_name": "ARCHITECTURE",
"visible": true,
"editable": true,
"properties": [
{
"name": "id",
"value": "architecture"
},
{
"name": "enable",
"value": "true"
}
],
"tooltip": "Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed"
},
{
"default_value": "",
"label": "Execution Path",
"variable_name": "EXECUTIONDIRECTORY",
"visible": false,
"editable": true,
"properties": [
{
"name": "id",
"value": "exedir"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Your job’s execution directory"
},
{
"default_value": "",
"label": "Error Path",
"variable_name": "ERRORPATH",
"visible": false,
"editable": true,
"properties": [
{
"name": "id",
"value": "errorpath"
},
{
"name": "useExecutionPath",
"value": false
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines the path to be used for the standard error stream of the job"
},
{
"default_value": "",
"label": "Output Path",
"variable_name": "OUTPUTPATH",
"visible": false,
"editable": true,
"properties": [
{
"name": "id",
"value": "outputpath"
},
{
"name": "useExecutionPath",
"value": false
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines the path to be used for the standard output stream of the job"
},
{
"default_value": "false",
"label": "Merge Streams",
"variable_name": "JOIN",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "join"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Merge stderr and stdout streams?"
},
{
"default_value": "false",
"label": "Hold Job",
"variable_name": "HOLD",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "hold"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Specifies that a user hold be applied to the job at submission time"
},
{
"default_value": "",
"label": "Script Shell",
"variable_name": "SHELL",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "shell"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Declares the shell that interprets the job script, e.g. /bin/bash"
},
{
"default_value": "true",
"label": "Moab Environment Variables",
"variable_name": "MOABENVIRONMENTVARIABLES",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "moabenvironmentvariables"
},
{
"name": "enable",
"value": "true"
}
],
"tooltip": "Push Moab environment variables to job?"
},
{
"default_value": "",
"label": "Email Notification List",
"variable_name": "MAILLIST",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "maillist"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Specifies the list of users to whom mail is sent by the execution server. Overrides the EMAILADDRESS specified on the USERCFG [credential]"
},
{
"default_value": "",
"label": "Email Options",
"variable_name": "EMAILOPTIONS",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "emailoptions"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "A list of requested email options"
},
{
"default_value": "",
"label": "Generic Resources",
"variable_name": "GENERICRESOURCES",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "genericresources"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Allows for specification of additional job attributes"
},
{
"default_value": "",
"label": "Job Env Variables",
"variable_name": "Job Environment Variables",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "jobEnvVariables"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"label": "Moab Job Template",
"variable_name": "MOABTEMPLATE",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "moabtemplates"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Defines set of MOAB job templates"
},
{
"default_value": "SHARED",
"label": "Node Access Policy",
"variable_name": "NODEACCESSPOLICY",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "node-access-policy"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "FIRSTAVAILABLE",
"label": "Node Allocation Policy",
"variable_name": "NODEALLOCATIONPOLICY",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "node-allocation-policy"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "EXACTSET",
"label": "Node Requested Policy",
"variable_name": "NODESREQUESTEDPOLICY",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "nodes-requested-policy"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"label": "Operating System",
"variable_name": "OPERATINGSYSTEM",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "operatingSystem"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"label": "Requested Features",
"variable_name": "FEATURESREQUESTED",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "features-requested"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Contains a list of features that are required for the job to run"
},
{
"default_value": "",
"label": "Excluded Features",
"variable_name": "FEATURESEXCLUDED",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "features-excluded"
},
{
"name": "enable",
"value": "false"
}
],
"tooltip": "Contains a list of features that can not be present on hardware the job needs to run"
},
{
"default_value": "",
"label": "Nodes Requested List",
"variable_name": "NODESREQUESTED",
"visible": false,
"editable": false,
"properties": [
{
"name": "id",
"value": "nodes-requested"
},
{
"name": "enable",
"value": "false"
}
]
}
],
"sections": [
{
"name": "defaults",
"value": "Basic Job Settings"
},
{
"name": "timeManagement",
"value": "Time Management"
},
{
"name": "credentials",
"value": "Credentials"
},
{
"name": "resources",
"value": "Resources"
},
{
"name": "dataManagement",
"value": "Data Management"
},
{
"name": "custom",
"value": "Custom Settings"
},
{
"name": "basic",
"value": "Basic Settings"
},
{
"name": "advanced",
"value": "Advanced Settings"
},
{
"name": "description",
"value": "Application Description"
}
],
"permissions": [
{
"name": "ALL",
"type": "user"
},
{
"name": "ALL",
"type": "group"
},
{
"name": "ALL",
"type": "account"
}
]
}
Response
{
"url": "http://10.2.184.87:8081/api/templates/7/",
"history_url": null,
"changed_by": "moab-admin",
"current": true,
"date": "2016-09-13T07:42:36.204904Z",
"id": 7,
"name": "New Template",
"type": "regular",
"description": {
"text": "",
"visible": false
},
"owner": "moab-admin",
"permissions": [
{
"name": "ALL",
"type": "account"
},
{
"name": "ALL",
"type": "group"
},
{
"name": "ALL",
"type": "user"
}
],
"published": true,
"sections": [
{
"name": "defaults",
"value": "Basic Job Settings"
},
{
"name": "timeManagement",
"value": "Time Management"
},
{
"name": "credentials",
"value": "Credentials"
},
{
"name": "resources",
"value": "Resources"
},
{
"name": "dataManagement",
"value": "Data Management"
},
{
"name": "custom",
"value": "Custom Settings"
},
{
"name": "basic",
"value": "Basic Settings"
},
{
"name": "advanced",
"value": "Advanced Settings"
},
{
"name": "description",
"value": "Application Description"
}
],
"use": 0,
"widgets": [
{
"default_value": "",
"editable": true,
"label": "Name",
"variable_name": "NAME",
"visible": true,
"properties": [
{
"name": "id",
"value": "name"
},
{
"name": "enable",
"value": "true"
}
]
},
{
"default_value": "0",
"editable": true,
"label": "Duration",
"variable_name": "DURATION",
"visible": true,
"properties": [
{
"name": "id",
"value": "duration"
},
{
"name": "enable",
"value": "true"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Job Arrays",
"variable_name": "arrays",
"visible": false,
"properties": [
{
"name": "id",
"value": "arrays"
},
{
"name": "enable",
"value": "false"
},
{
"name": "start-value",
"value": "0"
},
{
"name": "end-value",
"value": "1"
},
{
"name": "start-variable",
"value": "STARTINDEX"
},
{
"name": "end-variable",
"value": "ENDINDEX"
}
]
},
{
"default_value": "0",
"editable": false,
"label": "Delay Start By",
"variable_name": "ELIGIBLEDATE",
"visible": false,
"properties": [
{
"name": "id",
"value": "eligibledate"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "0",
"editable": false,
"label": "User Priority",
"variable_name": "USERPRIORITY",
"visible": false,
"properties": [
{
"name": "id",
"value": "priority"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Submission Script",
"variable_name": "SCRIPT",
"visible": true,
"properties": [
{
"name": "id",
"value": "script"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Account",
"variable_name": "ACCOUNT",
"visible": false,
"properties": [
{
"name": "id",
"value": "account"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Queue / Class",
"variable_name": "DESTINATIONQUEUE",
"visible": false,
"properties": [
{
"name": "id",
"value": "destinationQueue"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Quality of Service",
"variable_name": "QOS",
"visible": false,
"properties": [
{
"name": "id",
"value": "qos"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Number of Cores",
"variable_name": "NUMOFCORES",
"visible": true,
"properties": [
{
"name": "id",
"value": "cpupernode"
},
{
"name": "totalamount",
"value": "True"
},
{
"name": "nodeswithcount",
"value": "True"
},
{
"name": "malleablecorecount",
"value": "True"
},
{
"name": "totalamount_editable",
"value": "True"
},
{
"name": "nodeswithcount_editable",
"value": "True"
},
{
"name": "malleablecorecount_editable",
"value": "True"
},
{
"name": "totalamount_visible_default",
"value": "True"
},
{
"name": "nodeswithcount_visible_default",
"value": "False"
},
{
"name": "malleablecorecount_visible_default",
"value": "False"
},
{
"name": "totalcores_default",
"value": "1"
},
{
"name": "totalnodes_default",
"value": "1"
},
{
"name": "corespernode_default",
"value": "1"
},
{
"name": "minimumcores_default",
"value": "1"
},
{
"name": "maximumcores_default",
"value": "2"
},
{
"name": "enable",
"value": "true"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Memory (GB)",
"variable_name": "MEMORYAMOUNT",
"visible": true,
"properties": [
{
"name": "id",
"value": "memorypernode"
},
{
"name": "totalmemory",
"value": "True"
},
{
"name": "memorypercore",
"value": "True"
},
{
"name": "totalmemory_visible_default",
"value": "False"
},
{
"name": "memorypercore_visible_default",
"value": "True"
},
{
"name": "totalmemory_default",
"value": "0.50"
},
{
"name": "memorypercore_default",
"value": "0.50"
},
{
"name": "totalmemory_editable",
"value": "True"
},
{
"name": "memorypercore_editable",
"value": "True"
},
{
"name": "enable",
"value": "true"
}
]
},
{
"default_value": "linux",
"editable": true,
"label": "Architecture",
"variable_name": "ARCHITECTURE",
"visible": true,
"properties": [
{
"name": "id",
"value": "architecture"
},
{
"name": "enable",
"value": "true"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Execution Path",
"variable_name": "EXECUTIONDIRECTORY",
"visible": false,
"properties": [
{
"name": "id",
"value": "exedir"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Error Path",
"variable_name": "ERRORPATH",
"visible": false,
"properties": [
{
"name": "id",
"value": "errorpath"
},
{
"name": "useExecutionPath",
"value": "False"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": true,
"label": "Output Path",
"variable_name": "OUTPUTPATH",
"visible": false,
"properties": [
{
"name": "id",
"value": "outputpath"
},
{
"name": "useExecutionPath",
"value": "False"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "false",
"editable": false,
"label": "Merge Streams",
"variable_name": "JOIN",
"visible": false,
"properties": [
{
"name": "id",
"value": "join"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "false",
"editable": false,
"label": "Hold Job",
"variable_name": "HOLD",
"visible": false,
"properties": [
{
"name": "id",
"value": "hold"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Script Shell",
"variable_name": "SHELL",
"visible": false,
"properties": [
{
"name": "id",
"value": "shell"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "true",
"editable": false,
"label": "Moab Environment Variables",
"variable_name": "MOABENVIRONMENTVARIABLES",
"visible": false,
"properties": [
{
"name": "id",
"value": "moabenvironmentvariables"
},
{
"name": "enable",
"value": "true"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Email Notification List",
"variable_name": "MAILLIST",
"visible": false,
"properties": [
{
"name": "id",
"value": "maillist"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Email Options",
"variable_name": "EMAILOPTIONS",
"visible": false,
"properties": [
{
"name": "id",
"value": "emailoptions"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Generic Resources",
"variable_name": "GENERICRESOURCES",
"visible": false,
"properties": [
{
"name": "id",
"value": "genericresources"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Job Env Variables",
"variable_name": "Job Environment Variables",
"visible": false,
"properties": [
{
"name": "id",
"value": "jobEnvVariables"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Moab Job Template",
"variable_name": "MOABTEMPLATE",
"visible": false,
"properties": [
{
"name": "id",
"value": "moabtemplates"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "SHARED",
"editable": false,
"label": "Node Access Policy",
"variable_name": "NODEACCESSPOLICY",
"visible": false,
"properties": [
{
"name": "id",
"value": "node-access-policy"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "FIRSTAVAILABLE",
"editable": false,
"label": "Node Allocation Policy",
"variable_name": "NODEALLOCATIONPOLICY",
"visible": false,
"properties": [
{
"name": "id",
"value": "node-allocation-policy"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "EXACTSET",
"editable": false,
"label": "Node Requested Policy",
"variable_name": "NODESREQUESTEDPOLICY",
"visible": false,
"properties": [
{
"name": "id",
"value": "nodes-requested-policy"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Operating System",
"variable_name": "OPERATINGSYSTEM",
"visible": false,
"properties": [
{
"name": "id",
"value": "operatingSystem"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Requested Features",
"variable_name": "FEATURESREQUESTED",
"visible": false,
"properties": [
{
"name": "id",
"value": "features-requested"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Excluded Features",
"variable_name": "FEATURESEXCLUDED",
"visible": false,
"properties": [
{
"name": "id",
"value": "features-excluded"
},
{
"name": "enable",
"value": "false"
}
]
},
{
"default_value": "",
"editable": false,
"label": "Nodes Requested List",
"variable_name": "NODESREQUESTED",
"visible": false,
"properties": [
{
"name": "id",
"value": "nodes-requested"
},
{
"name": "enable",
"value": "false"
}
]
}
],
"version_description": "",
"version": 1
}
Related Topics