{ "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", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:config-modify": { "post": { "tags": [ "Misc" ], "summary": "ConfigModify", "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/ConfigModifyRequest" }, { "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:configure": { "post": { "tags": [ "Misc" ], "summary": "Configure", "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/ConfigureRequest" }, { "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:config-scale-out": { "post": { "tags": [ "Misc" ], "summary": "ConfigScaleOut", "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/ConfigScaleOutRequest" }, { "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": {} } }, "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": {} } }, "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": {} } }, "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/AuditRequest" }, { "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": {} } }, "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/CheckLockRequest" }, { "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": {} } }, "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/ConfigBackupRequest" }, { "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": {} } }, "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/ConfigRestoreRequest" }, { "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": {} } }, "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/DetachVolumeRequest" }, { "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": {} } }, "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/EvacuateRequest" }, { "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": {} } }, "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": {} } }, "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/MigrateRequest" }, { "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": {} } }, "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/QuiesceTrafficRequest" }, { "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": {} } }, "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": {} } }, "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", "schema": { "type": "boolean", "example": true } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RebuildRequest" }, { "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": "Rebuild", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\",\"snapshot-id\":\"{{snapshot-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": "Rebuild", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\",\"snapshot-id\":\"{{snapshot-id}}\"}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:restart": { "post": { "tags": [ "Misc" ], "summary": "Restart", "description": "Use the Restart command to restart a VM.", "operationId": "Restart", "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/RestartRequest" }, { "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": "Restart", "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": "Restart", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:resume-traffic": { "post": { "tags": [ "Misc" ], "summary": "ResumeTraffic", "description": "The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced. This command is executed using an Ansible playbook or Chef cookbook. Request Structure: The payload does not have any parameters.", "operationId": "ResumeTraffic", "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/ResumeTrafficRequest" }, { "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": "ResumeTraffic", "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": "ResumeTraffic", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:snapshot": { "post": { "tags": [ "Misc" ], "summary": "Snapshot", "description": "Creates a snapshot of a VM. The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful. This command can be applied to a VM in any VNF type. The only restriction is that the particular VNF should be built based on the generic heat stack. Note: Snapshot is not reliable unless the VM is in a stopped, paused, or quiesced (no traffic being processed) status. It is up to the caller to ensure that the VM is in one of these states. NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.", "operationId": "Snapshot", "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/SnapshotRequest" }, { "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": "Snapshot", "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": "Snapshot", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:start": { "post": { "tags": [ "Misc" ], "summary": "Start", "description": "Use the Start command to start a VM that is stopped. NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.", "operationId": "Start", "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/StartRequest" }, { "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": "Start", "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": "Start", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:start-application": { "post": { "tags": [ "Misc" ], "summary": "StartApplication", "description": "Starts the VNF application, if needed, after a VM is instantiated/configured or after VM start or restart. Supported using Chef cookbook or Ansible playbook only. A successful StartApplication request returns a success response. A failed StartApplication action returns a failure response code and the specific failure message in the response block.", "operationId": "StartApplication", "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/StartApplicationRequest" }, { "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": "StartApplication", "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": "StartApplication", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:stop": { "post": { "tags": [ "Misc" ], "summary": "Stop", "description": "Use the Stop command to stop a VM that was running.", "operationId": "Stop", "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/StopRequest" }, { "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": "Stop", "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": "Stop", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:stop-application": { "post": { "tags": [ "Misc" ], "summary": "StopApplication", "description": "Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only. A successful StopApplication request returns a success response. A failed StopApplication action returns a failure response code and the specific failure message in the response block.", "operationId": "StopApplication", "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/StopApplicationRequest" }, { "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": "StopApplication", "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": "StopApplication", "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": {} } }, "deprecated": false } }, "/appc-provider-lcm:sync": { "post": { "tags": [ "Misc" ], "summary": "Sync", "description": "The Sync action updates the current configuration in the APPC store with the running configuration from the device. A successful Sync returns a success status. A failed Sync returns a failure response status and failure messages in the response payload block. 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).", "operationId": "Sync", "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/SyncRequest" }, { "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": "Sync", "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": "Sync", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:unlock": { "post": { "tags": [ "Misc" ], "summary": "Unlock", "description": "Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF. Unlock is a command intended for APPC and does not execute an actual VNF command. Instead, unlock will release the VNF from the exclusive access held by the specific request-id allowing other requests for the VNF to be accepted. The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected. The Unlock command will only return success if the VNF was locked with same request-id. The Unlock command returns only one final response with the status of the request processing. Note: APPC locks the target VNF during any command processing. If an Unlock action is then requested on that VNF with a different request-id, it will be rejected because the VNF is already locked for another process, even though no actual lock command was explicitly invoked.", "operationId": "Unlock", "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/UnlockRequest" }, { "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": "Unlock", "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": "Unlock", "action-identifiers": { "vnf-id": "{{vnf-id}}" } } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:upgrade-backout": { "post": { "tags": [ "Misc" ], "summary": "UpgradeBackout", "description": "The Sync action updates the current configuration in the APPC store with the running configuration from the device. A successful Sync returns a success status. A failed Sync returns a failure response status and failure messages in the response payload block. 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).", "operationId": "UpgradeBackout", "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/UpgradeBackoutRequest" }, { "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": "UpgradeBackout", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } ] }, "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": "UpgradeBackout", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:upgrade-backup": { "post": { "tags": [ "Misc" ], "summary": "UpgradeBackup", "description": "The UpgradeBackup LCM action does a full backup of the VNF data prior to an upgrade. The backup is done on the Ansible or Chef server in a location that is specified in the playbook or cookbook. If there is an existing backup, it is overwritten by the new backup. This command is executed using an Ansible playbook or Chef cookbook. Request Structure: The payload does not have any parameters required.", "operationId": "UpgradeBackup", "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/UpgradeBackupRequest" }, { "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": "UpgradeBackup", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } ] }, "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": "UpgradeBackup", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:upgrade-post-check": { "post": { "tags": [ "Misc" ], "summary": "UpgradePostCheck", "description": "Success: If the UpgradePostCheck run successfully, it returns a success status code 400. The response payload contains the results of the check (Completed or Failed).", "operationId": "UpgradePostCheck", "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/UpgradePostCheckRequest" }, { "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": "UpgradePostCheck", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } ] }, "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": "UpgradePostCheck", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:upgrade-pre-check": { "post": { "tags": [ "Misc" ], "summary": "UpgradePreCheck", "description": "The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF (i.e. processing traffic). This command is executed using an Ansible playbook or Chef cookbook.", "operationId": "UpgradePreCheck", "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/UpgradePreCheckRequest" }, { "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": "UpgradePreCheck", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } ] }, "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": "UpgradePreCheck", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/appc-provider-lcm:upgrade-software": { "post": { "tags": [ "Misc" ], "summary": "UpgradeSoftware", "description": "The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF (i.e. processing traffic). This command is executed using an Ansible playbook or Chef cookbook.", "operationId": "UpgradeSoftware", "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/UpgradeSoftwareRequest" }, { "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": "UpgradeSoftware", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } ] }, "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": "UpgradeSoftware", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } } }, "components": { "schemas": { "HealthCheckAppcRequest": { "title": "HealthCheckAppcRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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}}\"}}" } } }, "Input": { "title": "Input", "required": [ "common-header", "action", "action-identifiers", "payload" ], "type": "object", "properties": { "common-header": { "$ref": "#/components/schemas/CommonHeader" }, "action": { "type": "string" }, "action-identifiers": { "$ref": "#/components/schemas/ActionIdentifiers" }, "payload": { "type": "string" } }, "example": { "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}}\"}}" } }, "CommonHeader": { "title": "CommonHeader", "required": [ "timestamp", "api-ver", "originator-id", "request-id", "sub-request-id", "flags" ], "type": "object", "properties": { "timestamp": { "type": "string" }, "api-ver": { "type": "string" }, "originator-id": { "type": "string" }, "request-id": { "type": "string" }, "sub-request-id": { "type": "string" }, "flags": { "$ref": "#/components/schemas/Flags" } }, "example": { "timestamp": "{{serverDate}}", "api-ver": "2.00", "originator-id": "{{orginatorId}}", "request-id": "Postman", "sub-request-id": "Postman", "flags": { "mode": "NORMAL", "force": "TRUE", "ttl": 36000 } } }, "Flags": { "title": "Flags", "required": [ "mode", "force", "ttl" ], "type": "object", "properties": { "mode": { "type": "string" }, "force": { "type": "string" }, "ttl": { "type": "integer", "format": "int32" } }, "example": { "mode": "NORMAL", "force": "TRUE", "ttl": 36000 } }, "ActionIdentifiers": { "title": "ActionIdentifiers", "required": [ "vnf-id", "vf-module-id", "vnfc-name", "vserver-id" ], "type": "object", "properties": { "vnf-id": { "type": "string" }, "vf-module-id": { "type": "string" }, "vnfc-name": { "type": "string" }, "vserver-id": { "type": "string" } }, "example": { "vnf-id": "{{vnf-id}}", "vf-module-id": "", "vnfc-name": "", "vserver-id": "" } }, "ConfigModifyRequest": { "title": "ConfigModifyRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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\"}}" } } }, "ConfigureRequest": { "title": "ConfigureRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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}}\"}}" } } }, "ConfigScaleOutRequest": { "title": "ConfigScaleOutRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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\"}}" } } }, "ActionStatusRequest": { "title": "ActionStatusRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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}}\"}" } } }, "Input4": { "title": "Input4", "required": [ "common-header", "action", "action-identifiers", "payload" ], "type": "object", "properties": { "common-header": { "$ref": "#/components/schemas/CommonHeader" }, "action": { "type": "string" }, "action-identifiers": { "$ref": "#/components/schemas/ActionIdentifiers4" }, "payload": { "type": "string" } }, "example": { "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}}\"}" } }, "ActionIdentifiers4": { "title": "ActionIdentifiers4", "required": [ "vnf-id" ], "type": "object", "properties": { "vnf-id": { "type": "string" } }, "example": { "vnf-id": "{{vnf-id}}" } }, "AttachVolumeRequest": { "title": "AttachVolumeRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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}}\"}" } } }, "Input5": { "title": "Input5", "required": [ "common-header", "action", "action-identifiers", "payload" ], "type": "object", "properties": { "common-header": { "$ref": "#/components/schemas/CommonHeader" }, "action": { "type": "string" }, "action-identifiers": { "$ref": "#/components/schemas/ActionIdentifiers5" }, "payload": { "type": "string" } }, "example": { "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}}\"}" } }, "ActionIdentifiers5": { "title": "ActionIdentifiers5", "required": [ "vnf-id", "vserver-id" ], "type": "object", "properties": { "vnf-id": { "type": "string" }, "vserver-id": { "type": "string" } }, "example": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" } }, "AuditRequest": { "title": "AuditRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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\"}" } } }, "CheckLockRequest": { "title": "CheckLockRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "{}" } } }, "ConfigBackupRequest": { "title": "ConfigBackupRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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\"}}" } } }, "ConfigRestoreRequest": { "title": "ConfigRestoreRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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\"}}" } } }, "DetachVolumeRequest": { "title": "DetachVolumeRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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}}\"}" } } }, "EvacuateRequest": { "title": "EvacuateRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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}}\"}" } } }, "LockRequest": { "title": "LockRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input12" } }, "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}}" } } } }, "Input12": { "title": "Input12", "required": [ "common-header", "action", "action-identifiers" ], "type": "object", "properties": { "common-header": { "$ref": "#/components/schemas/CommonHeader" }, "action": { "type": "string" }, "action-identifiers": { "$ref": "#/components/schemas/ActionIdentifiers4" } }, "example": { "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}}" } } }, "MigrateRequest": { "title": "MigrateRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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}}\"}" } } }, "QuiesceTrafficRequest": { "title": "QuiesceTrafficRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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\"}" } } }, "RebootRequest": { "title": "RebootRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input15" } }, "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}}\"}" } } }, "Input15": { "title": "Input15", "required": [ "common-header", "action", "action-identifiers", "payload" ], "type": "object", "properties": { "common-header": { "$ref": "#/components/schemas/CommonHeader" }, "action": { "type": "string" }, "action-identifiers": { "$ref": "#/components/schemas/ActionIdentifiers15" }, "payload": { "type": "string" } }, "example": { "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}}\"}" } }, "ActionIdentifiers15": { "title": "ActionIdentifiers15", "required": [ "vserver-id" ], "type": "object", "properties": { "vserver-id": { "type": "string" } }, "example": { "vserver-id": "{{vserver-id}}" } }, "RebuildRequest": { "title": "RebuildRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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": "Rebuild", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\",\"snapshot-id\":\"{{snapshot-id}}\"}" } } }, "RestartRequest": { "title": "RestartRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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": "Restart", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\"}" } } }, "ResumeTrafficRequest": { "title": "ResumeTrafficRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "ResumeTraffic", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{}" } } }, "SnapshotRequest": { "title": "SnapshotRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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": "Snapshot", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\"}" } } }, "StartRequest": { "title": "StartRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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": "Start", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\"}" } } }, "StartApplicationRequest": { "title": "StartApplicationRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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": "StartApplication", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vf-module-id": "", "vnfc-name": "", "vserver-id": "" }, "payload": "{\"configuration-parameters\":{\"vnf_name\":\"{{vnf-name}}\",\"targetname\":\"12\",\"timeoutvalue\":\"11\"}}" } } }, "StopRequest": { "title": "StopRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input5" } }, "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": "Stop", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vserver-id": "{{vserver-id}}" }, "payload": "{\"vm-id\":\"{{vm-id}}\",\"identity-url\":\"{{identity-url}}\",\"tenant-id\":\"{{tenant-id}}\"}" } } }, "StopApplicationRequest": { "title": "StopApplicationRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input" } }, "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": "StopApplication", "action-identifiers": { "vnf-id": "{{vnf-id}}", "vf-module-id": "", "vnfc-name": "", "vserver-id": "" }, "payload": "{\"configuration-parameters\":{\"vnf_name\":\"{{vnf-name}}\",\"targetname\":\"12\",\"timeoutvalue\":\"11\"}}" } } }, "SyncRequest": { "title": "SyncRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "Sync", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{}" } } }, "UnlockRequest": { "title": "UnlockRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input12" } }, "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": "Unlock", "action-identifiers": { "vnf-id": "{{vnf-id}}" } } } }, "UpgradeBackoutRequest": { "title": "UpgradeBackoutRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "UpgradeBackout", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } }, "UpgradeBackupRequest": { "title": "UpgradeBackupRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "UpgradeBackup", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } }, "UpgradePostCheckRequest": { "title": "UpgradePostCheckRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "UpgradePostCheck", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } }, "UpgradePreCheckRequest": { "title": "UpgradePreCheckRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "UpgradePreCheck", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } }, "UpgradeSoftwareRequest": { "title": "UpgradeSoftwareRequest", "required": [ "input" ], "type": "object", "properties": { "input": { "$ref": "#/components/schemas/Input4" } }, "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": "UpgradeSoftware", "action-identifiers": { "vnf-id": "{{vnf-id}}" }, "payload": "{\"existing-software-version\": \"3.1\", \"new-software-version\": \"3.2\"}" } } } }, "securitySchemes": { "httpBasic": { "type": "http", "scheme": "basic" } } }, "security": [ { "httpBasic": [] } ], "tags": [ { "name": "Misc", "description": "" } ] }