...
This command runs a VNF check (post- or pre-check) for distribute traffic specifically and returns the result.
Target URL | /restconf/operations/appc-provider-lcm:distribute-traffic-check |
Action | DIstributeTrafficCheckDistributeTrafficCheck |
Action-Identifiers | Vnf-id |
Payload Parameters | See below |
Revision History | Unchanged in this release |
...
Parameter | Description | Required? | Example |
---|---|---|---|
configuration-parameters | A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the values supplied. The parameters are associated with request template defined with CDT | Yes | “payload”"payload": “"{\"configuration-parameters\":{\"distribution_config_file_name\":\"/opt/onap/ccsdk/Playbooks/dt/config", "playbook":-vpkg-1-config.json\",\"distribution_config_file_content\":\"{...}\",\"playbook\":\"ansible_vfw_distributetraffic@0distributetraffic@0.00.yml\",\"node_list\":\"[vpkgvfw-1]\", \"is_post_check\": True}}”" |
Exemplary CDT template for Ansible protocol:
{
"PlaybookName": ${playbook},
"NodeList": ${node_list},
"EnvParameters": {
"
...
IsPostCheck":
...
"IsPostCheck": true/false,
"vfw_ip": „192.168.10.110",
"vsink_ip": „192.168.20.240"
}]
},
${is_post_check},
"ConfigFileName": ${distribution_config_file}
},
"FileParameters": {
${distribution_config_file} : ${distribution_config_file_content}
},
"Timeout": 3600
}
EnvParameters includes protocol specific parameters , here for Ansible playbook or Chef cookbook. Here with information if the Check is performed before or after traffic distribution. Ansible playbook or Chef cookbook. Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.distribution (IsPostCheck) and with further information about the distribution that will be performed (PreCheck) or for the one that was already performed (PostCheck). EnvParameters has two mandatory parameters: "IsPostCheck" and the second one that folds information about name of file with configuration of traffic distrribution. FileParameters section specifies content of file that will be uploaded to Ansible server, the file will be loaded by playbook as Input parameters. This file holds information provided by the OOF in DistributeTraffic optimization Response: Traffic Distribution
DistributeTrafficCheck Response
...
Success: A successful distribute check returns a success status code 400 after all traffic has been distributed.when pre- or post- check conditions are satisfied
Success: A successful Failure: A failed distribute check returns a failure success status code 401 and the failure message from the Ansible or Chef server in the response payload block.when pre- or post- check conditions are not satisfied