ressubscr
ResidentialSubscriberManager

Defines the Residential Subscriber Manager object

• Relative Name=[res-subscr-mgr]
• Displayed Name=Residential Subscriber Manager

Input Parameters:

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.
clearHostStruct : ressubscr.ClearHostStruct - clearHostStruct of dynamic host objects with desired IP address of host, site id, SAP ID or subscriber ID whose values are used to be cleared. The structure must have set Site ID, ipAddress of host .
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

Output Parameters:

aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

Input Parameters:

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.
clearSapStruct : ressubscr.ClearSapStruct - clearSapStruct of dynamic host objects with desired SAP ID whose values are used to be cleared. The configuration objects must have set SAP ID. An optional parameter hostType can be provided, if only IPv4(DHCP) hosts needs to cleared value should be v4. if only IPv6(IPoE-DHCP6) hosts needs to cleared value should be v6. By default, it will clear both IPv4 and IPv6 hosts.
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

Output Parameters:

aOutResult : List (clear.RequestHandleStruct) - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

Input Parameters:

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.
neSystemAddress : string - System address of the NE to deploy the profile or policy to (i.e. where the sub resides). NFM-P may detect that a requested profile/policy already exists in NFM-P but hasn't been deployed to this node yet; then NFM-P will deploy it.
vlanPerSub : boolean - true for SAP (VLAN) per subscriber false for SAP (VLAN) per service (any flavor)
esm : boolean - false if subscriber uses assigned SAPs; true otherwise (enhanced subscriber management a.k.a. ESM)
templates : Map (string to ressubscr.TemplateIdPair) - Map of the NFM-P profiles or QoS policies FDNs to clone. The values: structures containing two strings: 1) "ossAssignedName" - the name OSS assigned to this profile or policy. 2) "fdn" - the FDN of the template SLA profile (for ESM) or QoS/scheduler policy to replicate (for assigned SAPs). The keys follow the naming convention: * For ESM: Application|"subscriber" Where: o Application can be one of (unchecked): "all"|"hsi"|voip"|"video"" "all" is used for VLAN per subscriber model, other values - for VLAN per service models o "subscriber" represents the subscriber profile * For assigned SAP model: Direction-Application-PolicyType Where: o Direction: "ingress"|"egress" o Application - the same values as in the ESM case above - i.e. "all"|"hsi"|voip"|"video" o PolicyType: "qos"|"scheduler" Examples of the keys in the map: - "subscriber" - ESM, VLAN per subscriber, subscriber profile, at most 1 entry - "all" - ESM, VLAN per subscriber, SLA profile, at most 1 entry - "hsi" - ESM, VLAN per service, SLA profile - "ingress-all-qos" - assigned SAP, VLAN per subscriber, QoS policy - "egress-hsi-scheduler" - assigned SAP, VLAN per service, scheduler policy An invocation should have the following entries: - for ESM, VLAN per subscriber: "subscriber", "all" - for ESM, VLAN per service: "subscriber", "all","hsi",voip","video" - for assigned SAPs, VLAN per subscriber: "egress-all-qos" "egress-all-scheduler" "ingress-all-qos" "ingress-all-scheduler" - for assigned SAPs, VLAN per service: "egress-hsi-qos" "egress-hsi-scheduler" "ingress-hsi-qos" "ingress-hsi-scheduler" "egress-video-qos" "egress-video-scheduler" "ingress-video-qos" "ingress-video-scheduler" "egress-voip-qos" "egress-voip-scheduler" "ingress-voip-qos" "ingress-voip-scheduler"
downstreamLineRate : int - Subscriber downstream DSL line rate
upstreamLineRate : int - Subscriber upstream DSL line rate
ingressAcls : Map (string to string) - Map of ingress ACL FDNs to use in the clone. Keys are the applications: - for VLAN per service models: "hsi"|voip"|"video" (unchecked) - for VLAN per subscriber model: "all" (1 and only 1 entry). DEFAULT blank (null)
egressAcls : Map (string to string) - Map of ingress ACL FDNs to use in the clone. Keys are the applications: - for VLAN per service models: "hsi"|voip"|"video" (unchecked) - for VLAN per subscriber model: "all" (1 and only 1 entry). DEFAULT blank (null)
allRates : Map (string to int) - Map of all rates to configure in the profiles/ (QoS/scheduler) policies being created Entries are named using the following convention: Direction-ForwardingClass-CirOrPir-Application-svcNumber where: Direction: "ingress"|"egress" ForwardingClass: "be"|"l2"|"af"|"l1"|"h2"|"ef"|"h1"|"nc" CirOrPir: "cir"|"pir" - CIR cannot be specified without corresponding PIR rate configuration. Both CIR and PIR may be specified as "-1" meaning "MAX" Application (unchecked): "hsi"|voip"|"video" svcNumber: 1..n (unique integer per application instance) Example: "ingress-ef-pir-video-1"
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

Output Parameters:

fdnList : Map (string to string) - The map of FDNs of (top-level) objects created when executing this request. The keys are the OSS assigned names passed in the parameters "templates". The values are the FDNs of NFM-P global profiles/ policies created for this request.

Exceptions:

ressubscr.ResidentialSubscriberManager.createSubSvcComponentsException

Input Parameters:

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.
serviceComponentsConfig : ressubscr.ServiceComponentsCreateConfiguration - Subscriber Service component create configuration
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

Output Parameters:

fdnList : Map (string to string) - The map of FDNs of (top-level) objects created when executing this request. The keys are the OSS assigned names passed in the parameters "templates", ingress/egressAclNames, and ingress/egressIpv6AclNames. The values are the FDNs of NFM-P global profiles/ policies created for this request.

Exceptions:

ressubscr.ResidentialSubscriberManager.createSubSvcComponentsDynException

Input Parameters:

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.
neSystemAddress : string - System address of the NE to remove the profile or policy from (i.e. where the sub resides). The value "0.0.0.0" requests the removal of the profiles/policies from ALL nodes in the network (i.e. globally).
fdns : List (string) - FDNs of the profiles/policies to be deleted.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

Output Parameters:

result : boolean - Success or failure. Fails if a profile/policy is still used by some subscriber/host/SAP and hence can't be deleted. Failure to delete scheduler and QoS policies created implicitly when cloning subscriber of SLA profiles IS NOT treated as an error.

Exceptions:

ressubscr.ResidentialSubscriberManager.deleteSubSvcComponentsException

Input Parameters:

timeout : long - The number of milliseconds to wait before receiving the results. If the results are not received in the given time, the method returns.
subscriberRetrievalInfoList : List (ressubscr.ResidentialSubscriberRetrievalStruct) -
retrieveQoSOvr : boolean - (Optional) Specifies if QoS Override should be retrieved,the default is "true". The QoS Override won't be retrieved if Service preferences "retrieveQoSOvr" is false.
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

Output Parameters:

result : List (ressubscr.ResidentialSubscriberResultStruct) - Residential Subscriber Instance info object where only persisted information about Residential Subscriber Instance is set.

Exceptions:

ressubscr.ResidentialSubscriberManager.retrieveResidentialSubscribersException

Input Parameters:

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.
velocityTemplateMethodName : string - Name of the ACL Velocity Template Method (@TEMPLATE)
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

Output Parameters:

result : List (string) - List of FDNs affected by Template modification

Exceptions:

ressubscr.ResidentialSubscriberManager.updateSubSvcComponentsDynAclException