| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| configuredClass |
The managed object class name of the configured object.
type=string access=read-create minimum=0 maximum=255 Mandatory on create Displayed(tab/group)=Templated Object Class Name (/Configuration Template) |
| configuredClassCategories |
The template categories assigned to this template.
This property is mandatory and cannot have empty value.
The format of the value must be the following:
[category1][category2]...[categoryN] where the category names are in square brackets.
Example:
if the value is "[service:tls][service:vll]" then this template can be used for any VPLS/MVPLS or any VLL services.
The previous value is equivalent to
[service:tls:vpls][service:tls:mvpls][service:vll] or
[service:tls:vpls][service:tls:mvpls][service:vll:epipe][service:vll:apipe][service:vll:fpipe][service:vll:ipipe][service:vll:cpipe] or
[service:tls][service:vll:epipe][service:vll:apipe][service:vll:fpipe][service:vll:ipipe][service:vll:cpipe].
Any combination of the following categories is allowed:
[equipment] - the template can be used for equipment
[equipment:auxalarmdefinition] - the template can be used for equipment Auxiliary Alarm Definition
[service] - the template can be used by all service types
[service:ies] - the template can be used for IES service
[service:vprn] - the template can be used for VPRN service
[service:tls] - the template can be used for any VPLS/MVPLS service
[service:tls:vpls] - the template can be used for VPLS service
[service:tls:mvpls] - the template can be used for MVPLS service
[service:vll] - the template can be used for any VLL service
[service:vll:epipe] - the template can be used for Epipe service
[service:vll:apipe] - the template can be used for Apipe service
[service:vll:fpipe] - the template can be used for Fpipe service
[service:vll:ipipe] - the template can be used for Ipipe service
[service:vll:cpipe] - the template can be used for Cpipe service
[service:mirror] - the template can be used for Mirror service
[service:vlan] - the template can be used for Vlan service
[tunnel:sdp] - the template can be used for service tunnel
[tunnel:lsp] - the template can be used for LSP
[wireless] - the template can be used for wireless
[wireless:lte] - the template can be used for wireless LTE (eNodeB)
type=string access=read-create minimum=0 maximum=255 Mandatory on create Displayed(tab/group)=Templated Object Categories (/Configuration Template) |
| includeChildrenCreation |
Specifies that children creation from child templates associated with this template must be included during object creation.
This is only supported for [wireless] and [wireless:lte] categories.
type=boolean default=false Displayed(tab/group)=Include Children Creation (/Configuration Template) |
| numberOfChildTemplates |
Number of child templates associated with this template.
type=int access=read-only default=0 Displayed(tab/group)=Number Of Child Templates (/Template Usage) |
| numberOfParentTemplates |
Number of parent templates associated with this template.
type=int access=read-only default=0 Displayed(tab/group)=Number Of Parent Templates (/Template Usage) |
| numberOfTemplatedObjects |
Number of templated objects associated with this template.
type=long access=read-only default=0 Displayed(tab/group)=Number Of Templated Objects (/Template Usage) |
| script.XmlApiVersion-Set |
type=Children-Set |
| showCreatedObject |
When an object is created using this template, show the created object in a new window.
type=boolean default=false Displayed(tab/group)=Show Created Object (/Configuration Template) |
| Properties inherited from script.AbstractScript |
|---|
| autoSaveResult, bundleId, contentType, mtosi_description, mtosi_id, mtosi_type, nextVersionId, schedule, scheduleTask, scopeOfCommandProfilePointer, scriptMode, scriptName, scriptState, spanObjectPointer, useLatestVersion |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
associatedObjectPointer
: Pointer - Full name of another template or full name of a templatable object.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
associatedObject
: generic.CommonManagedEntityInformation - Returns the object the input parameter 'associatedObjectPointer' is referring to.
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
oldTemplatePointers
: List (Pointer) - The old templates that has to be converted.
Must be instance of class 'template.Template'.
templateConfiguration
: config(script.XmlApiConfigTemplate) - The new template configuration.
Th configuredClassName property does not have to be set as it is derived from the old Template.
Optionally it may specify the ID of the new XML API Configuration Template script.
In case of default ID (0) the value will be auto-generated (the ID of the old template is never reused).
updateExistingServices
: boolean - All services created from the old service template will be updated.
updateExistingSites
: boolean - The service sites of all services created from the old service template will be updated.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
generatedTemplates
: List (generic.CommonManagedEntityInformation) - The generated templates.
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
templateTargetParameters
: Map (string to config(script.TargetParameter)) - The parameters and values of the executed template.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
resultList
: List (Pointer) - The full names of the configured objects.
script.XmlApiConfigTemplate.executeException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
multiTemplateTargetParameters
: script.MultiTemplateTargetParameterMap - The parameters and values of the executed template.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
resultList
: List (Pointer) - The full names of the configured objects.
script.XmlApiConfigTemplate.executeMultiException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
templateConfiguration
: config(script.XmlApiConfigTemplate) - The template configuration.
At least the configuredClassName property must be set.
Optionally it may specify the ID of the new XML API Configuration Template script.
In case of default ID (0) the value will be auto-generated.
additionalParameters
: script.XmlApiConfigTemplateParams - The parameters of the template to be generated.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
generatedTemplate
: generic.CommonManagedEntityInformation - The generated template.
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
templateConfiguration
: config(script.XmlApiConfigTemplate) - The template configuration.
At least the configuredClassName property must be set.
Optionally it may specify the ID of the new XML API Configuration Template script.
In case of default ID (0) the value will be auto-generated.
sampleId
: string - The name of the sample.
parameters
: Map (string to Any) - The parameters used to generate template from the sample.
These parameters are optional and are specific to each sample.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
generatedTemplate
: generic.CommonManagedEntityInformation - The generated template.
| Methods inherited from script.AbstractScript |
|---|
| changeScriptVersion, configScriptVersion, configureScript, configureTarget, configureTargets, createScriptVersion |