- **Any (requires self-service onboarding)** Currently supported on any vnf-type which has been onboarded using the APPC self-service onboarding process. See further discussion on self-service onboarding below.
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| **Command** | **VNF** | **VF-Module** | **VNFC** | **VM** | **VNF/VM Types Supported** |
-+========================+===========+==================+================+==========+============================================================+
-| ActionStatus | Yes | | | | Any |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| AttachVolume | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Audit | Yes | | | | Any (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| CheckLock | Yes | | | | Any |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Configure | Yes | | | | Any (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| ConfigBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| ConfigModify | Yes | | | | Any (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| ConfigRestore | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| ConfigScaleOut | Yes | | | | Any (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| DetachVolume | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Evacuate | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| HealthCheck | Yes | | | | Any (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Lock | Yes | | | | Any |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Migrate | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| QuiesceTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Rebuild | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Restart | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| ResumeTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Snapshot | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Start | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| StartApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Stop | | | | Yes | Any (uses OpenStack command) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| StopApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Sync | Yes | | | | Any (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| Unlock | Yes | | | | Any |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| UpgradeBackout | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| UpgradeBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| UpgradePostCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| UpgradePreCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
-| UpgradeSoftware | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
-+------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| **Command** | **VNF** | **VF-Module** | **VNFC** | **VM** | **VNF/VM Types Supported** |
++=============================+===========+==================+================+==========+============================================================+
+| ActionStatus | Yes | | | | Any |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ActivateNESw | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| AttachVolume | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Audit | Yes | | | | Any (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| CheckLock | Yes | | | | Any |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Configure | Yes | | | | Any (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ConfigBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ConfigModify | Yes | | | | Any (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ConfigRestore | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ConfigScaleIn | Yes | | Yes | Yes | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ConfigScaleOut | Yes | | | | Any (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| DetachVolume | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| DistributeTraffic | Yes | | Yes | Yes | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| DistributeTrafficCheck | Yes | | Yes | Yes | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| DownloadNESw | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Evacuate | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| GetConfig | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| HealthCheck | Yes | | | | Any (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| LicenseManagement | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Lock | Yes | | | | Any |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Migrate | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PostEvacuate | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PostMigrate | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PostRebuild | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PreConfigure | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PreEvacuate | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PreMigrate | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| PreRebuild | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Provisioning | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| QuiesceTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Reboot | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Rebuild | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Restart | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| ResumeTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Snapshot | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Start | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| StartApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| StartTraffic | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| StatusTraffic | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Stop | | | | Yes | Any (uses OpenStack command) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| StopApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| StopTraffic | Yes | | | | Ansible |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Sync | Yes | | | | Any (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| Unlock | Yes | | | | Any |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| UpgradeBackout | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| UpgradeBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| UpgradePostCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| UpgradePreCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
+| UpgradeSoftware | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
++-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
request- id=c09ac7d1-de62-0016-2000-e63701125559 AND
vnf-id=ctsf0007v", "code": 315``
+ActivateNESw
+---------------
+
+The ActivateNESw LCM action activates the target software version needed for a software upgrade.
+
+This command is executed using an Ansible playbook or Chef cookbook.
+
+Request Structure:
+
++--------------------------+------------------------------------------------------------+
+| **Target URL** | /restconf/operations/appc-provider-lcm:activate-n-e-sw |
++--------------------------+------------------------------------------------------------+
+| **Action** | ActivateNESw |
++--------------------------+------------------------------------------------------------+
+| **Action-identifiers** | vnf-id |
++--------------------------+------------------------------------------------------------+
+| **Payload Parameters** | See below |
++--------------------------+------------------------------------------------------------+
+| **Revision History** | New in Frankfurt |
++--------------------------+------------------------------------------------------------+
+
+Request Payload Parameters:
+
++--------------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++==========================+=====================================+=====================+===============================================================================================+
+| swVersionToBeActivated | The software to be activated | Yes | "payload": |
+| | | | "{\"swVersionToBeActivated\": \"v2\"}" |
++--------------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
+
+ActivateNESw Response
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Success:** If the ActivateNESw runs successfully, it returns a success status code 400. The response payload contains the results of the activating.
+
+Response Payload Parameters:
+
++-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++=================+=============================+=====================+==============================================================================================================================+
+| result | Returns the result | Yes | |
+| | of the activate-n-e-sw. | | "payload": |
+| | Indicates Success or | | "{\\"result\\": \\"Success\\"}” |
+| | Failure. | | |
++-----------------+-----------------------------+---------------------+ |
+| reason | If not Success, | | |
+| | reason contains | | |
+| | explanation. | | |
++-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
+
+**Failure:** If an ActivateNESw fails to run, it returns a failure code 401 and the failure reason from the Ansible or Chef server in the response payload block.
+
AttachVolume
------------
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
| **Parameter** | **Description** | **Required?** | **Example** |
+======================+===========================================================================================================================================================+=====================+==================================+
-| publish-config | \* If the publish\_config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus | Yes | "publish-config": "<Y\|N>" |
+| publish-config | \* If the publish\-config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus | Yes | "publish-config": "<Y\|N>" |
| | | | |
-| | \* If the publish\_config field is set to N in the payload, then: | | |
+| | \* If the publish\-config field is set to N in the payload, then: | | |
| | | | |
| | - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration | | |
| | | | |
| | be specified. | | |
+-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
+ConfigModify Request
+^^^^^^^^^^^^^^^^^^^^
+
+ Examples::
+
+ {
+ "input": {
+ "common-header": {
+ "timestamp": "2017-10-25T11:10:04.244Z",
+ "api-ver": "2.00",
+ "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
+ "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
+ "sub-request-id": "1",
+ "flags": {
+ "force": "TRUE",
+ "ttl": 60000
+ }
+ },
+ "action": "ConfigModify",
+ "action-identifiers": {
+ "vnf-id": "<VNF_ID>"
+ },
+ "payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",
+ \"config-json\": \"{\"pg-streams\":{
+ \"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" },
+ {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" },
+ { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },
+ { \"id\":\"fw_udp4\", \"is-enabled\": \"true\" },
+ {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
+ }
+ }
+ }
+
+
ConfigModify Response
^^^^^^^^^^^^^^^^^^^^^
A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
+------------------------------+-----------------------------------------------------------+
-| **Target URL** | /restconf/operations/appc-provider-lcm:configbackup |
+| **Target URL** | /restconf/operations/appc-provider-lcm:config-backup |
+------------------------------+-----------------------------------------------------------+
| **Action** | ConfigBackup |
+------------------------------+-----------------------------------------------------------+
**Failure:** A failed ConfigRestore returns a failure code 401 and the failure message.
+ConfigScaleIn
+-------------
+
+The ConfigScaleIn command is used to apply any actions on a VNF as part of a ScaleIn flow. Actions could include updating the VNF configuration or running a set of other tasks.
+
+The ConfigScaleIn action can have multiple APPC templates associated with it. APPC retrieves the VfModuleModelName from A&AI (model.model-vers.model-name), which is used as the unique identifier to select the correct APPC template.
+APPC creates or updates VNFC records in A&AI for the newly instantiated VM’s. The orchestration-status of the VNFC’s is set to CONFIGURED.
+
+This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
+
+|
+
++------------------------------+------------------------------------------------------------------------------------------+
+| **Target URL** | /restconf /operations/appc-provider-lcm:config-scale-in |
++------------------------------+------------------------------------------------------------------------------------------+
+| **Action** | ConfigScaleIn |
++------------------------------+------------------------------------------------------------------------------------------+
+| **Action-Identifiers** | Vnf-id |
++------------------------------+------------------------------------------------------------------------------------------+
+| **Payload Parameters** | See below |
++------------------------------+------------------------------------------------------------------------------------------+
+| **Revision History** | New in Frankfurt |
++------------------------------+------------------------------------------------------------------------------------------+
+
+|
+
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
+| **Payload Parameter** | **Description** | **Required?** | **Example** |
++=================================+==================================================================================================================================================================+=====================+=============================================+
+| request-parameters | vnf-host-ip-address: optional if Netconf or other direct interface to the VNF. If not provided, the vnf-host-ip-address will be obtained from A&AI. | No | "payload": |
+| +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ "{\\"request-parameters \\": |
+| | vf-module-id: used to determine the A&AI VM inventory associated with ConfigScaleIn. | Yes | { |
+| +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ \\"vnf-host-ip-address\\": |
+| | controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleIn. | | \\”value\\”, |
+| | Will be needed if A&AI does not contain the template identifier. | No | \\”vf-module-id\\”: \\”value\\”, |
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ \\”controller-template-id\\”: |
+| configuration-parameters | A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the | No | \\”value\\” |
+| | values supplied. | | } |
+| | | | |
+| | | | \\"configuration-parameters\\": |
+| | | | {\\"<CONFIG- PARAMS>\\"} |
+| | | | |
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
+
+ConfigScaleIn Response
+^^^^^^^^^^^^^^^^^^^^^^
+
+**Success:**
+
+ - A successful ConfigScaleIn returns a success status code 400 when completed.
+
+**Failure:**
+
+ - A failed ConfigScaleIn returns a failure code 401 and the failure message.
+ - If the ConfigScaleIn is successfully performed on the VNF but there is a failure to update A&AI inventory, an intermediate failure message with failure code 501 is returned prior to the final 400 success message.
+
+
ConfigScaleOut
--------------
- itemNotFound
- conflict
+DistributeTraffic
+-----------------
+
+The Distribute Traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
+The entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
+realization of request. Parameters present in configuration file specify where and how traffic should be distributed,
+including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy.
+Format of configuration file is specific to each VNF type. The Optimization Framework component and Homing, Allocation and
+Placement mechanism can be used to retrieve instances of vf-modules of anchor points and destination points with
+corresponding policies.
+
+This command is executed using an Ansible playbook or Chef cookbook.
+
+Request Structure:
+
++--------------------------+--------------------------------------------------------------+
+| **Target URL** | /restconf/operations/appc-provider-lcm:distribute-traffic |
++--------------------------+--------------------------------------------------------------+
+| **Action** | DistributeTraffic |
++--------------------------+--------------------------------------------------------------+
+| **Action-identifiers** | vnf-id, vserver-id, vnfc-name |
++--------------------------+--------------------------------------------------------------+
+| **Payload Parameters** | See below |
++--------------------------+--------------------------------------------------------------+
+| **Revision History** | New in Casablanca |
++--------------------------+--------------------------------------------------------------+
+
+Request Payload Parameters:
+
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
+| **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 | No | "payload": "{\"configuration-parameters\": {\"file_parameter_content\": |
+| | values supplied. The parameters are associated with request template defined with CDT | | \"{\\\"destinations\\\": [{\\\"locationType\\\": \\\"att_aic\\\", |
+| | | | \\\"isRehome\\\": \\\"false\\\", \\\"aic_version\\\": \\\"1\\\", |
+| | | | \\\"ipv4-oam-address\\\": \\\"\\\", \\\"nf-name\\\": |
+| | | | \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"cloudOwner\\\": |
+| | | | \\\"CloudOwner\\\", \\\"service_instance_id\\\": |
+| | | | \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\", |
+| | | | \\\"vf-module-id\\\": \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\", |
+| | | | \\\"cloudClli\\\": \\\"clli1\\\", \\\"ipv6-oam-address\\\": \\\"\\\", |
+| | | | \\\"vf-module-name\\\": \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\", |
+| | | | \\\"vnfHostName\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"nf-id\\\": |
+| | | | (...) |
+| | | | \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1-vfw_private_1_port-6yfzndtyjzfz\\\", |
+| | | | \\\"ipv4-addresses\\\": [\\\"192.168.20.100\\\"], \\\"interface-id\\\": |
+| | | | \\\"0a1d0300-de02-46e8-99f6-e786f1ba407a\\\", \\\"network-name\\\": |
+| | | | \\\"\\\", \\\"ipv6-addresses\\\": []}]}], \\\"nf-type\\\": \\\"vnf\\\"}]}\", |
+| | | | \"fixed_ip_address\": \"10.0.210.103\", \"book_name\": |
+| | | | \"vpgn/latest/ansible/distributetraffic/site.yml\", |
+| | | | \"ne_id\": \"vofwl01pgn4407\"}}", |
+| | | | |
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
+
+Exemplary CDT template for Ansible protocol::
+
+ {
+ "InventoryNames": "VM",
+ "PlaybookName": "${()=(book_name)}",
+ "NodeList": [{
+ "vm-info": [{
+ "ne_id": "${()=(ne_id)}",
+ "fixed_ip_address": "${()=(fixed_ip_address)}"
+ }],
+ "site": "site",
+ "vnfc-type": "some-vnfc"
+ }],
+ "EnvParameters": {
+ "ConfigFileName": "../traffic_distribution_config.json",
+ "vnf_instance": "instance",
+ },
+ "FileParameters": {
+ "traffic_distribution_config.json": "${()=(file_parameter_content)}"
+ },
+ "Timeout": 3600
+ }
+
+EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
+Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.
+
+DistributeTraffic Response
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The response does not include any payload parameters.
+
+**Success:** A successful distribute returns a success status code 400 after all traffic has been distributed.
+
+**Failure:** A failed distribute returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
+
+
+DistributeTrafficCheck
+----------------------
+
+The Distribute Traffic Check LCM action complements Distribute Traffic LCM action with capabilities to test if destination point
+is ready to handle traffic or if anchor point accepts the configuration of destinations for traffic distribution. Finally,
+this action can be used to check if destination points handle traffic accordingly with the configuration.
+
+This command is executed using an Ansible playbook or Chef cookbook.
+
+Request Structure:
+
++--------------------------+--------------------------------------------------------------------+
+| **Target URL** | /restconf/operations/appc-provider-lcm:distribute-traffic-check |
++--------------------------+--------------------------------------------------------------------+
+| **Action** | DistributeTrafficCheck |
++--------------------------+--------------------------------------------------------------------+
+| **Action-identifiers** | vnf-id, vserver-id, vnfc-name |
++--------------------------+--------------------------------------------------------------------+
+| **Payload Parameters** | See below |
++--------------------------+--------------------------------------------------------------------+
+| **Revision History** | New in Dublin |
++--------------------------+--------------------------------------------------------------------+
+
+Request Payload Parameters:
+
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
+| **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 | No | "payload": "{\"configuration-parameters\": |
+| | values supplied. The parameters are associated with request template defined with CDT | | {\"file_parameter_content\": \"{\\\"destinations\\\": |
+| | | | [ |
+| | | | {\\\"locationType\\\": \\\"att_aic\\\", |
+| | | | \\\"isRehome\\\": \\\"false\\\", |
+| | | | \\\"aic_version\\\": \\\"1\\\", |
+| | | | \\\"ipv4-oam-address\\\": \\\"\\\", |
+| | | | \\\"nf-name\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", |
+| | | | \\\"cloudOwner\\\": \\\"CloudOwner\\\", |
+| | | | \\\"service_instance_id\\\": |
+| | | | \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\", |
+| | | | \\\"vf-module-id\\\": |
+| | | | \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\", |
+| | | | \\\"cloudClli\\\": \\\"clli1\\\", |
+| | | | \\\"ipv6-oam-address\\\": \\\"\\\", |
+| | | | \\\"vf-module-name\\\": |
+| | | | \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\", |
+| | | | \\\"vnfHostName\\\": |
+| | | | \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", |
+| | | | \\\"nf-id\\\": \\\"909d396b-4d99-4c6a-a59b-abe948873303\\\", |
+| | | | (...) |
+| | | | \\\"trafficPresence\\\": true}\", |
+| | | | \"fixed_ip_address\": \"10.0.110.1\", \"book_name\": |
+| | | | \"vfw-sink/latest/ansible/distributetrafficcheck/site.yml\", |
+| | | | \"ne_id\": \"vofwl02vfw4407\"}}" |
+| | | | |
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
+
+Exemplary CDT template for Ansible protocol::
+
+ {
+ "InventoryNames": "VM",
+ "PlaybookName": "${()=(book_name)}",
+ "NodeList": [{
+ "vm-info": [{
+ "ne_id": "${()=(ne_id)}",
+ "fixed_ip_address": "${()=(fixed_ip_address)}"
+ }],
+ "site": "site",
+ "vnfc-type": "some-vnfc"
+ }],
+ "EnvParameters": {
+ "ConfigFileName": "../traffic_distribution_config.json",
+ "vnf_instance": "instance",
+ },
+ "FileParameters": {
+ "traffic_distribution_config.json": "${()=(file_parameter_content)}"
+ },
+ "Timeout": 3600
+ }
+
+EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
+Distribute Traffic config file can have similar parameters like the one Distribute Traffic action and can have some extra information like the type of check to
+be performed. In the payload example there is a trafficPresence parameter that emphasises if the traffic is expected on vFW instance.
+
+DistributeTrafficCheck Response
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The response does not include any payload parameters.
+
+**Success:** A successful distribute traffic check returns a success status code 400 when conditions are satisfied.
+
+**Failure:** A failed check returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
+
+
+DownloadNESw
+---------------
+
+The DownloadNESw LCM action downloads the target software needed for a software upgrade.
+
+This command is executed using an Ansible playbook or Chef cookbook.
+
+Request Structure:
+
++--------------------------+------------------------------------------------------------+
+| **Target URL** | /restconf/operations/appc-provider-lcm:download-n-e-sw |
++--------------------------+------------------------------------------------------------+
+| **Action** | DownloadNESw |
++--------------------------+------------------------------------------------------------+
+| **Action-identifiers** | vnf-id |
++--------------------------+------------------------------------------------------------+
+| **Payload Parameters** | See below |
++--------------------------+------------------------------------------------------------+
+| **Revision History** | New in Frankfurt |
++--------------------------+------------------------------------------------------------+
+
+Request Payload Parameters:
+
++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++=======================+=====================================+=====================+===============================================================================================+
+| swToBeDownloaded | The software to be downloaded | Yes | "payload": |
+| | | | "{\"swToBeDownloaded\": \"\\\\'[{\\\\\\\"swLocation\\\\\\\": |
+| | | | \\\\\\\"http://192.168.1.10:10080/ran_du_pkg1-v2.zip\\\\\\\"}]\\\\'\"}" |
++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
+
+DownloadNESw Response
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Success:** If the DownloadNESw runs successfully, it returns a success status code 400. The response payload contains the results of the downloading.
+
+Response Payload Parameters:
+
++-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++=================+=============================+=====================+==============================================================================================================================+
+| result | Returns the result | Yes | |
+| | of the download-n-e-sw. | | "payload": |
+| | Indicates Success or | | "{\\"result\\": \\"Success\\"}” |
+| | Failure. | | |
++-----------------+-----------------------------+---------------------+ |
+| reason | If not Success, | | |
+| | reason contains | | |
+| | explanation. | | |
++-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
+
+**Failure:** If a DownloadNESw fails to run, it returns a failure code 401 and the failure reason from the Ansible or Chef server in the response payload block.
+
Evacuate
--------
**Failure:** A failed Evacuate returns a failure code 401 and the failure message.
+GetConfig
+---------
+
+GetConfig LCM action for the MVM VNF types using the GetConfig playbook
+to retrieve the current config. This is limited to Ansible.
+
+A successful GetConfig request returns a success response.
+
+A failed GetConfig action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== =================================================
+**Target URL** /restconf/operations/appc-provider-lcm: GetConfig
+====================== =================================================
+**Action** GetConfig
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== =================================================
+
+========================= ========================================================================================================= ============= ======================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= ======================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
+
+ "payload": "{}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= ======================================================================================================
+
+GetConfig Response:
+~~~~~~~~~~~~~~~~~~~
+
+Success: A successful GetConfig returns a success status code 400.
+
+Failure: A failed GetConfig returns a failure code 401 and the failure
+message.
+
HealthCheck
-----------
**Failure:** If the VNF is unable to run the HealthCheck. APP-C returns the error code 401 and the http error message.
+LicenseManagement
+-----------------
+
+For LicenseManagement LCM action, invoke the LicenseManagement playbook.
+This is limited to Ansible.
+
+A successful LicenseManagement request returns a success response.
+
+A failed LicenseManagement action returns a failure response code and
+the specific failure message in the response block.
+
+
+====================== ========================================================
+**Target URL** /restconf/operations/appc-provider-lcm:LicenseManagement
+====================== ========================================================
+**Action** LicenseManagement
+**Action-Identifiers** vnf-id
+**Payload Parameters** See below
+**Revision History** New in Frankfurt
+====================== ========================================================
+
+========================= ========================================================================================================= ============= ======================================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= ======================================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "action": "LicenseManagement",
+
+ "action-identifiers": {
+
+ "vnf-id": "rarf9901v"
+
+ },
+
+ "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\",\"license_action\":\"update\"}}" ---
+
+ license_action can have any of these values ={ upload \| add \| install \| update \| renew \| delete \| revoke \| … }:
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= ======================================================================================================================
+
+LicenseManagement Response\ **:**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful LicenseManagement returns a success status code
+400.
+
+Failure: A failed LicenseManagement returns a failure code 401 and the
+failure message.
+
+
+
Lock
----
**Failure:** A failed Migrate returns a failure code 401 and the failure message.
+PostEvacuate
+-------------
+
+PostEvacuate LCM action using the PostEvacuate playbook. This is limited
+to Ansible.
+
+A successful PostEvacuate request returns a success response.
+
+A failed PostEvacuate action returns a failure response code and the
+specific failure message in the response block.
+
+====================== ====================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PostEvacuate
+====================== ====================================================
+**Action** PostEvacuate
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ====================================================
+
+========================= ========================================================================================================= ============= =====================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =====================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =====================================================================================================
+
+PostEvacuate Response:
+~~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful PostEvacuate returns a success status code 400.
+
+Failure: A failed PostEvacuate returns a failure code 401 and the
+failure message.
+
+
+PostMigrate
+-----------
+
+PostMigrate LCM action using the PostMigrate playbook. This is limited
+to Ansible.
+
+A successful PostMigrate request returns a success response.
+
+A failed PostMigrate action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== ===================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PostMigrate
+====================== ===================================================
+**Action** PostMigrate
+**Action-Identifiers** vnf-id
+**Payload Parameters** See below
+**Revision History** New in Frankfurt
+====================== ===================================================
+
+========================= ========================================================================================================= ============= =====================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =====================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =====================================================================================================
+
+PostMigrate Response:
+~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful PostMigrate returns a success status code 400.
+
+Failure: A failed PostMigrate returns a failure code 401 and the failure
+message.
+
+
+
+PostRebuild
+-----------
+
+PostRebuild LCM action using the PostRebuild playbook. This is limited
+to Ansible.
+
+A successful PostRebuild request returns a success response.
+
+A failed PostRebuild action returns a failure response code and the
+specific failure message in the response block.
+
+====================== ===================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PostRebuild
+====================== ===================================================
+**Action** PostRebuild
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ===================================================
+
+========================= ========================================================================================================= ============= =====================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =====================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =====================================================================================================
+
+PostRebuild Response:
+~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful PostRebuild returns a success status code 400.
+
+Failure: A failed PostRebuild returns a failure code 401 and the failure
+message.
+
+
+PreConfig
+---------
+
+PreConfig LCM action for the MVM VNF types using the PreConfigure
+playbook. This is limited to Ansible.
+
+A successful PreConfig request returns a success response.
+
+A failed PreConfig action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== =================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PreConfig
+====================== =================================================
+**Action** PreConfig
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== =================================================
+
+========================= ========================================================================================================= ============= ======================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= ======================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
+
+ "payload": "{}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= ======================================================================================================
+
+PreConfig Response:
+-------------------
+
+Success: A successful PreConfig returns a success status code 400.
+
+Failure: A failed PreConfig returns a failure code 401 and the failure
+message.
+
+PreEvacuate
+------------
+
+PreEvacuate LCM action using the PreEvacuate playbook. This is limited
+to Ansible.
+
+A successful PreEvacuate request returns a success response.
+
+A failed PreEvacuate action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== ===================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PreEvacuate
+====================== ===================================================
+**Action** PreEvacuate
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ===================================================
+
+========================= ========================================================================================================= ============= =====================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =====================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =====================================================================================================
+
+PreEvacuate Response:
+~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful PreEvacuate returns a success status code 400.
+
+Failure: A failed PreEvacuate returns a failure code 401 and the failure
+message.
+
+PreMigrate
+----------
+
+PreMigrate LCM action using the PreMigrate playbook. This is limited to
+Ansible.
+
+A successful PreMigrate request returns a success response.
+
+A failed PreMigrate action returns a failure response code and the
+specific failure message in the response block.
+
+====================== ==================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PreMigrate
+====================== ==================================================
+**Action** PreMigrate
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ==================================================
+
+========================= ========================================================================================================= ============= =====================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =====================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =====================================================================================================
+
+PreMigrate Response:
+~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful PreMigrate returns a success status code 400.
+
+Failure: A failed PreMigrate returns a failure code 401 and the failure
+message.
+
+
+PreRebuild
+----------
+
+PreRebuild LCM action using the PreRebuild playbook. This is limited to
+Ansible.
+
+A successful PreRebuild request returns a success response.
+
+A failed PreRebuild action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== ==================================================
+**Target URL** /restconf/operations/appc-provider-lcm: PreRebuild
+====================== ==================================================
+**Action** PreRebuild
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ==================================================
+
+========================= ========================================================================================================= ============= =====================================================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =====================================================================================================
+request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =====================================================================================================
+
+PreRebuild Response:
+~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful PreRebuild returns a success status code 400.
+
+Failure: A failed PreRebuild returns a failure code 401 and the failure
+message.
+
+
+Provisioning
+------------
+
+For Provisioning LCM action, invoke the Provisioning playbook. This is
+limited to Ansible.
+
+A successful Provisioning request returns a success response.
+
+A failed Provisioning action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== ===================================================
+**Target URL** /restconf/operations/appc-provider-lcm:Provisioning
+====================== ===================================================
+**Action** Provisioning
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ===================================================
+
+========================= ========================================================================================================= ============= =========================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =========================
+request- parameters Not used. This request is limited to Ansible only. No "action": "Provisioning",
+
+ "action-identifiers": {
+
+ "vnf-id": "rarf9901v"
+
+ },
+
+ "payload": "{}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =========================
+
+Provisioning Response\ **:**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful Provisioning returns a success status code 400.
+
+Failure: A failed Provisioning returns a failure code 401 and the
+failure message.
+
+
+
QuiesceTraffic
--------------
A specific error message is returned if there is a timeout error.
+Reboot
+-------
+
+The Reboot is used to reboot a VM.
+
+
+There are two types supported: HARD and SOFT. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.
+
+**NOTE:** The command implementation is based on OpenStack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
+
++------------------------------+-----------------------------------------------------------------------------------------------+
+| **Input Block** | api-ver should be set to 2.00 for current version of Reboot |
++------------------------------+-----------------------------------------------------------------------------------------------+
+| **Target URL** | /restconf/operations/appc-provider-lcm:reboot |
++------------------------------+-----------------------------------------------------------------------------------------------+
+| **Action** | Reboot |
++------------------------------+-----------------------------------------------------------------------------------------------+
+| **Action-identifiers** | Vnf-id, vserver-id |
++------------------------------+-----------------------------------------------------------------------------------------------+
+| **Payload Parameters** | See table below |
++------------------------------+-----------------------------------------------------------------------------------------------+
+| **Revision History** | New in R3 release. |
++------------------------------+-----------------------------------------------------------------------------------------------+
+
+Payload Parameters
++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++=================+===============================================+=================+=========================================+
+| type | The type of reboot. Values are | No | |
+| | HARD and SOFT. If not | | |
+| | specified, SOFT reboot is | | "payload": |
+| | performed. | | "{\\"type\\": \\"HARD\\", |
+| | | | \\"vm-id\\": \\"<VM-ID>\\", |
+| | | | \\"identity-url\\": |
+| | | | \\"<IDENTITY-URL>\\" |
+| | | | }" |
++-----------------+-----------------------------------------------+-----------------+ |
+| vm-id | The unique identifier (UUID) of | Yes | |
+| | the resource. For backwards- | | |
+| | compatibility, this can be the self- | | |
+| | link URL of the VM. | | |
+| | | | |
+| | | | |
+| | | | |
+| | | | |
++-----------------+-----------------------------------------------+-----------------+ |
+| identity-url | The identity url used to access the | Yes | |
+| | resource. | | |
++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
+
+Reboot Response
+^^^^^^^^^^^^^^^
+
+**Success:** A successful Rebuild returns a success status code 400.
+
+**Failure:** A failed Rebuild returns a failure code 401 and the failure message.
Rebuild
-------
The StartApplication response returns an indication of success or failure of the request.
+StartTraffic
+------------
+
+For StartTraffic LCM action, invoke the StartTraffic playbook. This is
+limited to Ansible.
+
+A successful StartTraffic request returns a success response.
+
+A failed StartTraffic action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== ===================================================
+**Target URL** /restconf/operations/appc-provider-lcm:StartTraffic
+====================== ===================================================
+**Action** StartTraffic
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ===================================================
+
+========================= ========================================================================================================= ============= =========================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= =========================
+request- parameters Not used. This request is limited to Ansible only. No "action": "StartTraffic",
+
+ "action-identifiers": {
+
+ "vnf-id": "rarf9901v"
+
+ },
+
+ "payload": "{}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= =========================
+
+StartTraffic Response\ **:**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful StartTraffic returns a success status code 400.
+
+Failure: A failed StartTraffic returns a failure code 401 and the
+failure message.
+
+
+
+StatusTraffic
+-------------
+
+For StatusTraffic LCM action, invoke the StatusTraffic playbook. This is
+limited to Ansible.
+
+A successful StatusTraffic request returns a success response.
+
+A failed StatusTraffic action returns a failure response code and the
+specific failure message in the response block.
+
+====================== ====================================================
+**Target URL** /restconf/operations/appc-provider-lcm:StatusTraffic
+====================== ====================================================
+**Action** StatusTraffic
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ====================================================
+
+========================= ========================================================================================================= ============= ==========================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= ==========================
+request- parameters Not used. This request is limited to Ansible only. No "action": "StatusTraffic",
+
+ "action-identifiers": {
+
+ "vnf-id": "rarf9901v"
+
+ },
+
+ "payload": "{}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= ==========================
+
+StatusTraffic Response\ **:**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful StatusTraffic returns a success status code 400.
+
+Failure: A failed StatusTraffic returns a failure code 401 and the
+failure message.
+
+
Stop
----
A failed StopApplication action returns a failure response code and the specific failure message in the response block.
+------------------------------+--------------------------------------------------------------+
-| **Target URL** | /restconf/operations/appc-provider-lcm:stopapplication |
+| **Target URL** | /restconf/operations/appc-provider-lcm:stop-application |
+------------------------------+--------------------------------------------------------------+
| **Action** | StopApplication |
+------------------------------+--------------------------------------------------------------+
The StopApplication response returns an indication of success or failure of the request.
+StopTraffic
+-----------
+
+For StopTraffic LCM action, invoke the StopTraffic playbook. This is
+limited to Ansible.
+
+A successful StopTraffic request returns a success response.
+
+A failed StopTraffic action returns a failure response code and the
+specific failure message in the response block.
+
+
+====================== ==================================================
+**Target URL** /restconf/operations/appc-provider-lcm:StopTraffic
+====================== ==================================================
+**Action** Provisioning
+**Action-Identifiers** vnf-id
+**Payload Parameters** See table
+**Revision History** New in Frankfurt
+====================== ==================================================
+
+========================= ========================================================================================================= ============= ========================================================================
+**Payload Parameter** **Description** **Required?** **Example**
+========================= ========================================================================================================= ============= ========================================================================
+request- parameters Not used. This request is limited to Ansible only. No "action": "StopTraffic",
+
+ "action-identifiers": {
+
+ "vnf-id": "rarf9901v"
+
+ },
+
+ "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\"}}"
+configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
+========================= ========================================================================================================= ============= ========================================================================
+
+StopTraffic Response\ **:**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Success: A successful StopTraffic returns a success status code 400.
+
+Failure: A failed StopTraffic returns a failure code 401 and the failure
+message.
+
+
Sync
----
+------------------------------+---------------------------------------------------+
| **Action-identifiers** | Vnf-id |
+------------------------------+---------------------------------------------------+
-| **Payload Parameters** | None |
+| **Payload Parameters** | See below |
+------------------------------+---------------------------------------------------+
| **Revision History** | Unchanged in this release. |
+------------------------------+---------------------------------------------------+
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++======================+===========================================================================================================================================================+=====================+==================================+
+| publish-config | \* If the publish\-config field is set to Y in the payload, then always write the running configuration to file | Yes | "publish-config": "<Y\|N>" |
+| | | | |
+| | \* If the publish\-config field is set to N in the payload, then running configuration is not written to the file | | |
+| | | | |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
+
+
Unlock
------
Code Review / appc.git / blobdiff