@itentialopensource/adapter-onap_appc

openapi: 3.0.0 info: title: onap_appc contact: {} version: '1.0' servers: - url: http://example.com/restconf/operations variables: {} paths: /appc-provider-lcm:health-check: post: tags: - Misc summary: HealthCheckAppc description: '' operationId: HealthCheckAppc parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/HealthCheckAppcRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: HealthCheck action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"request-parameters":{"vnf-name":"{{vnf-name}}","host-ip-address":"{{host-ip-address}}"},"configuration-parameters":{"vnf_name":"{{vnf-name}}"}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: HealthCheck action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"request-parameters":{"vnf-name":"{{vnf-name}}","host-ip-address":"{{host-ip-address}}"},"configuration-parameters":{"vnf_name":"{{vnf-name}}"}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:config-modify: post: tags: - Misc summary: ConfigModify description: '' operationId: ConfigModify parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/HealthCheckAppcRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigModify action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigModify action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:configure: post: tags: - Misc summary: Configure description: '' operationId: Configure parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/HealthCheckAppcRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Configure action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"request-parameters":{"vnf-name":"{{vnf-name}}","host-ip-address":"{{host-ip-address}}"},"configuration-parameters":{"vnf_name":"{{vnf-name}}"}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Configure action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"request-parameters":{"vnf-name":"{{vnf-name}}","host-ip-address":"{{host-ip-address}}"},"configuration-parameters":{"vnf_name":"{{vnf-name}}"}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:config-scale-out: post: tags: - Misc summary: ConfigScaleOut description: '' operationId: ConfigScaleOut parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/HealthCheckAppcRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigModify action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigModify action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:action-status: post: tags: - Misc summary: ActionStatus description: The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF. This enables the client to know the status of a previous request and helps them decide if they should reissue a request. operationId: ActionStatus parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ActionStatusRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ActionStatus action-identifiers: vnf-id: '{{vnf-id}}' payload: '{"request-id":"{{request-id}}","sub-request-id":"{{sub-request-id}}","originator-id":"{{originator-id}}"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ActionStatus action-identifiers: vnf-id: '{{vnf-id}}' payload: '{"request-id":"{{request-id}}","sub-request-id":"{{sub-request-id}}","originator-id":"{{originator-id}}"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:attach-volume: post: tags: - Misc summary: AttachVolume description: 'The AttachVolume command attaches a cinder volume to a VM via an Openstack command. Cinder is a Block Storage service for OpenStack. It’s designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device. NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.' operationId: AttachVolume parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/AttachVolumeRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: AttachVolume action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"volumeId":"{{volumeId}}","device":"{{device}}","vm-id":"{{vm-id}}","identity-url":"{{identity-url}}"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: AttachVolume action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"volumeId":"{{volumeId}}","device":"{{device}}","vm-id":"{{vm-id}}","identity-url":"{{identity-url}}"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:audit: post: tags: - Misc summary: Audit description: 'The Audit command compares the configuration of the VNF associated with the current request against the most recent configuration that is stored in APPC’s configuration database. A successful Audit means that the current VNF configuration matches the latest APPC stored configuration. A failed Audit indicates that the configurations do not match. This command can be applied to any VNF type. The only restriction is that the VNF has been onboarded in self-service mode (which requires that the VNF supports a request to return the running configuration). The Audit action does not require any payload parameters. NOTE: Audit does not return a payload containing details of the comparison, only the Success/Failure status.' operationId: Audit parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ActionStatusRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Audit action-identifiers: vnf-id: '{{vnf-id}}' payload: '{"publish-config":"Y"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Audit action-identifiers: vnf-id: '{{vnf-id}}' payload: '{"publish-config":"Y"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:checklock: post: tags: - Misc summary: CheckLock description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned. A CheckLock command is deemed successful if the processing completes without error, whether the VNF is locked or not. The command returns only a single response with a final status. Note that APPC locks the target VNF during any VNF command processing, so a VNF can have a locked status even if no Lock command has been explicitly called. The CheckLock command returns a specific response structure that extends the default LCM response. The CheckLock action does not require any payload parameters. operationId: CheckLock parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ActionStatusRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: CheckLock action-identifiers: vnf-id: '{{vnf-id}}' payload: '{}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: CheckLock action-identifiers: vnf-id: '{{vnf-id}}' payload: '{}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:config-backup: post: tags: - Misc summary: ConfigBackup description: Stores the current VNF configuration on a local file system (not in APPC). This is limited to Ansible and Chef. There can only be one stored configuration (if there is a previously saved configuration, it is replaced with the current VNF configuration). A successful ConfigBackup request returns a success response. A failed ConfigBackup action returns a failure response code and the specific failure message in the response block. operationId: ConfigBackup parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/HealthCheckAppcRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigBackup action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigBackup action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:config-restore: post: tags: - Misc summary: ConfigRestore description: Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration. A successful ConfigRestore request returns a success response. A failed ConfigRestore action returns a failure response code and the specific failure message in the response block. operationId: ConfigRestore parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/HealthCheckAppcRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigRestore action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: ConfigRestore action-identifiers: vnf-id: '{{vnf-id}}' vf-module-id: '' vnfc-name: '' vserver-id: '' payload: '{"configuration-parameters":{"vnf_name":"{{vnf-name}}","targetname":"12","timeoutvalue":"11"}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:detach-volume: post: tags: - Misc summary: DetachVolume description: 'The DetachVolume command detaches a cinder volume from a VM via an Openstack command. Cinder is a Block Storage service for OpenStack. It’s designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self-service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device. NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.' operationId: DetachVolume parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/AttachVolumeRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: DetachVolume action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"volumeId":"{{volumeId}}","device":"{{device}}","vm-id":"{{vm-id}}","identity-url":"{{identity-url}}"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: DetachVolume action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"volumeId":"{{volumeId}}","device":"{{device}}","vm-id":"{{vm-id}}","identity-url":"{{identity-url}}"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:evacuate: post: tags: - Misc summary: Evacuate description: 'Evacuates a specified VM from its current host to another. After a successful evacuate, a rebuild VM is performed if a snapshot is available (and the VM boots from a snapshot). The host on which the VM resides needs to be down. If the target host is not specified in the request, it will be selected by relying on internal rules to evacuate. The Evacuate action will fail if the specified target host is not UP/ENABLED. After Evacuate, the rebuild VM can be disabled by setting the optional rebuild-vm parameter to false. A successful Evacuate action returns a success response. A failed Evacuate action returns a failure. NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.' operationId: Evacuate parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/AttachVolumeRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Evacuate action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"vm-id":"{{vm-id}}","identity-url":"{{identity-url}}","tenant-id":"{{tenant-id}}","rebuild-vm":"{{rebuild-vm}}","targethost-id":"{{targethost-id}}"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Evacuate action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"vm-id":"{{vm-id}}","identity-url":"{{identity-url}}","tenant-id":"{{tenant-id}}","rebuild-vm":"{{rebuild-vm}}","targethost-id":"{{targethost-id}}"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:lock: post: tags: - Misc summary: Lock description: Use the Lock command to ensure exclusive access during a series of critical LCM commands. The Lock action will return a successful result if the VNF is not already locked or if it was locked with the same request-id, otherwise the action returns a response with a reject status code. Lock is a command intended for APPC and does not execute an actual VNF command. Instead, lock will ensure that ONAP is granted exclusive access to the VNF. When a VNF is locked, any subsequent sequential commands with same request-id will be accepted. Commands associated with other request-ids will be rejected. APPC locks the target VNF during any VNF command processing. If a lock action is then requested on that VNF, it will be rejected because the VNF was already locked, even though no actual lock command was explicitly invoked. The lock automatically clears after 900 seconds (15 minutes). This 900 second value can be adjusted in the properties file operationId: Lock parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/LockRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Lock action-identifiers: vnf-id: '{{vnf-id}}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Lock action-identifiers: vnf-id: '{{vnf-id}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:migrate: post: tags: - Misc summary: Migrate description: 'Migrates a running target VM from its current host to another. A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation. Migrate suspends the guest virtual machine, and moves an image of the guest virtual machine’s disk to the destination host physical machine. The guest virtual machine is then resumed on the destination host physical machine and the disk storage that it used on the source host physical machine is freed. The migrate action will leave the VM in the same Openstack state the VM had been in prior to the migrate action. If a VM was stopped before migration, a separate VM-level restart command would be needed to restart the VM after migration. NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.' operationId: Migrate parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/AttachVolumeRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Migrate action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"vm-id":"{{vm-id}}","identity-url":"{{identity-url}}","tenant-id":"{{tenant-id}}"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Migrate action-identifiers: vnf-id: '{{vnf-id}}' vserver-id: '{{vserver-id}}' payload: '{"vm-id":"{{vm-id}}","identity-url":"{{identity-url}}","tenant-id":"{{tenant-id}}"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:quiesce-traffic: post: tags: - Misc summary: QuiesceTraffic description: The QuiesceTraffic LCM action gracefully stops the traffic on the VNF (i.e., no service interruption for traffic in progress). All application processes are assumed to be running but no traffic is being processed. This command is executed using an Ansible playbook or Chef cookbook. operationId: QuiesceTraffic parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ActionStatusRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: QuiesceTraffic action-identifiers: vnf-id: '{{vnf-id}}' payload: '{"operations-timeout":"3600"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: QuiesceTraffic action-identifiers: vnf-id: '{{vnf-id}}' payload: '{"operations-timeout":"3600"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:reboot: post: tags: - Misc summary: Reboot description: '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/.' operationId: Reboot parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple schema: type: boolean example: true requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/RebootRequest' - example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Reboot action-identifiers: vserver-id: '{{vserver-id}}' payload: '{"type":"HARD","vm-id":"{{vm-id}}","identity-url":"{{identity-url}}"}' example: input: common-header: timestamp: '{{serverDate}}' api-ver: '2.00' originator-id: '{{orginatorId}}' request-id: Postman sub-request-id: Postman flags: mode: NORMAL force: 'TRUE' ttl: 36000 action: Reboot action-identifiers: vserver-id: '{{vserver-id}}' payload: '{"type":"HARD","vm-id":"{{vm-id}}","identity-url":"{{identity-url}}"}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appc-provider-lcm:rebuild: post: tags: - Misc summary: Rebuild description: 'Recreates a target VM instance to a known, stable state. Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM. Rebuild VM uses the snapshot provided by the snapshot-id (if provided). If not provided, the latest snapshot is used. If there are no snapshots, it uses the (original) Glance image. APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.' operationId: Rebuild parameters: - name: X-TransactionId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 9999 - name: X-FromAppId in: header description: '' required: true style: simple schema: type: integer format: int32 example: 121 - name: Real-Time in: header description: '' required: true style: simple