Building Service Requests

Building Service Requests

Input Parameters

Download method:

Download destination:

addBasic Service Template File Example (device provision)

Example of NVPair List Passed to config_param (device provision)

Building Service Requests

This appendix describes how to build Service Requests for device provision/unprovision and subscriber provision/unprovision. An asterisk (*) indicates a mandatory input value entry to the attribute.

Input Parameters

* SecurityToken security_token.user_name // authenticated user id
* SecurityToken security_token.token_data: // call CNS API to get the value to be passed in.
* ServiceRequest prov_request.service_category_id, for example: /Default/ServiceProfiles/Devices/BroadBand/Prov/$ROLE. See note below for determining the value of $ROLE. In our case, SP and PP names are the same.

Note In the $CCNSC_HOME/CSCObacss/spm/profiles/BroadBand/pp directory, each provision profile "*.pp" is a role file. The value of $ROLE is the file name less the ".pp" extension. For example, if the file name is LACPPPoA.pp, the value of $ROLE is "LACPPPoA".

ServiceRequest prov_request.request_reference_id: a string or an empty string
ServiceRequest prov_request.description: a string or an empty string
ServiceRequest prov_request.operator_id: a string or an empty string
ServiceRequest prov_request.default_operation_type: ADD or DELETE (See note below)

Note It can be an empty string when FeatureData.operation_type has a value assigned to it. If values are assigned to both, this attribute and the FeatureData.operation_type, the value of FeatureData.operation_type has higher precendence to overwrite this value.

ServiceRequest prov_request.customer_id: string or emptry
ServiceRequest prov_request.service_parameters: CONFIG_FOR_PREVIEW (value: true| false) or empty string
* ServiceRequest prov_request.service_feature_list[i].feature_name:

Note Refer to the provision profile. Each provision profile lists all service feature names available for the specific role (for example: Basic, IPPool, PVCRange...).

ServiceRequest prov_request.service_feature_list[i].operation_type: ADD | DELETE

Note If no value assigned on the attribute "default_operation_type", then you should assign a value here.

* ServiceRequest prov_request.service_feature_list[i].feature_parameters
FEATURE_ID = "string" (not a mandatory input)

Note For device provision you should assign a unique string here. When you do the service unprovision, SPM server delete the service according to this string. It is import when you want to delete a service, the value of FEATURE_ID you pass here must be the same string you use in the device provision (add service).

Note For subscriber provision case a unique string is not required. The rule for assigning the value of FEATURE_ID for subscriber provision is:
Service subscriber provision: Value of FEATURE_ID=RDN of System_service_id value in network_elements.config_paramNVPair list
PVCRange and SinclePVC subscriber provision: Value of FEATURE_ID=RDN of System_interface_endpoint value in network_elements.config_paramNVPail list
Fallout subscriber provision: Value of FEATURE_ID=any unique string not equal to RDN of System_interface_endpoint value in network_elements_config_param NVPair list

Note For subscriber unprovisioncase use the same value of FEATURE_ID that is defined in the subscriber provision case.

SUBSCRIBER_ID = "mandatory only when you doing a subscirber provision". the FDN is: /systemTitle=ACT/SubscriberRoot/$ISP/{$SubscriberGroup}/$Subscriber
* ServiceRequest prov_request.service_feature_list[i].network_elements:

* id = /systemTitle=ACT/NIMRoot/$networkName/$deviceName
tag = string or empty string
* MODEL = 7206 | 7401 | C10K // for BroadBand package
* type: Aggregator | CPE
subtype: string or empty string
* NVPairSeq config_param (See note that follows).

Note Specify download method and destination without explicitly passing the information. The default values are picked up from respective PP.

What follows is a list of download methods and download destintation provided by BAC:

Download method:

case 1: PP_DOWNLOAD_METHOD = HTTP

SYNTAX_CHECK_ENABLED = true (default value is : false)

case 2: PP_DOWNLOAD_METHOD = Deployed_Only

case 3: PP_DOWNLOAD_METHOD = Console:portNumber (for example: Console:2011)

case 4: PP_DOWNLOAD_METHOD = File; DEST_FILE_NAME = fileName (it is put under $Instll_BAC/spm/logs )

case 5: If USE_SSH = true (optinal: when download method is telnet), SSHEncryption = 3des | des

case 6: PP_DOWNLOAD_METHOD = telnet (default value used by backend server)

Download destination:

case 1: PP_DESTINATION = StartUp (donwload to running and startup config)

case 2: PP_DESTINATION = Running (default)

Note See the variables from the corresponding template. To determine which template should be referenced, refer to the file in the following directory: $CCNSC_HOME/CSCObacss/spm/profiles/BroadBand/pp; the template directoryis $Install_BAC/common/templates/BroadBand.

Note For device provision pass all the template variables with values into config_param.

Note For device unprovisionall NVPair lists passed in device provision case are not required to be passed in unprovision case. The attrbiute in device unprovision case is optional.

Note For subscriber provision pass all template variables with values to this attribute.

Note For subscriber unprovisionall NVPair List what you have passed in subscriber provision case should be exactly the same as those passed to this attribute.

addBasic Service Template File Example (device provision)

<?BAC_VERSION version="2.5"?>

</VarDeclaration>

</SubTemplateDeclaration>

<MainTemplateDef><![CDATA[

#set ($radius = "RADIUS")

#set ($tt = "true")

no logging console

ip cef

aaa new-model

#if ($System_COND_RADIUS == $radius)

aaa authentication ppp default radius local

#else

aaa authentication ppp default local

#end

aaa authorization network default group radius

virtual-profile aaa

#if ($System_COND_CNOTE == $tt)

logging on

logging $System_CNOTE_ip_address

#end

]]></MainTemplateDef>

<NegationTemplateDef><![CDATA[

]]></NegationTemplateDef>

<UserSection><![CDATA[

<type>SingleDataSet</type>

<classPath>com.cisco.dslnms.tmog.ActionHandle</classPath>

</action>

</style>

<name>System_COND_RADIUS</name>

<displayName>Authentication Type</displayName>

<required>false</required>

<disabled>false</disabled>

<invisible>false</invisible>

<String >RADIUS</String>

<String >LOCAL</String>

</defaultValueList>

</DropdownList>

<name>System_COND_CNOTE</name>

<displayName>CNOTE</displayName>

<required>false</required>

<disabled>false</disabled>

<invisible>false</invisible>

<String >System_CNOTE_ip_address</String>

</enableVarList>

</CheckBox>

<name>System_CNOTE_ip_address</name>

<displayName>CNOTE IP Address</displayName>

<required>false</required>

<classPath>com.cisco.dslnms.tmog.actions.TmogBasicCnoteHandle</classPath>

</action>

<disabled>false</disabled>

<invisible>false</invisible>

<readOnly>false</readOnly>

</IPV4Field>

</componentList>

</GuiDescription>

]]></UserSection>

</Template>

Example of NVPair List Passed to config_param (device provision)

System_COND_RADIUS = RADIUS

System_COND_CNOTE = true

System_CNOTE_ip_address = a.b.c.d

Table of Contents

Building Service Requests

Input Parameters

Download method:

Download destination:

addBasic Service Template File Example (device provision)

Example of NVPair List Passed to config_param (device provision)