Page Comparison

The below json requests contain a variety of different request types for Action requests in APPC.

Code Block

language	js
theme	Confluence
title	APPC Provider - OpenStack Direct
linenumbers	true
collapse	true

{
      "input":{
            "common-request-header":{
                  "service-request-id":"1"
            },
            "vnf-resource":{
                  "vm-id":"http://10.12.25.2:8774/v2.1/466979b815b5415ba14ada713e6e1846/servers/e8020a03-5cd9-4f8c-b2d8-9972a256cf6a",
                  "identity-url":"http://10.12.25.2:5000/v3"
            }
      }
}

Code Block

theme	Confluence
title	APPC Provider - VM Restart (MultiCloud)
linenumbers	true
collapse	true

{
      "input":{
            "common-request-header":{
                  "service-request-id":"1"
            },
            "vnf-resource":{
                  "vm-id":"http://10.0.14.1:80/api/multicloud-titanium_cloud/v0/pod25_RegionOne/compute/v2.1/466979b815b5415ba14ada713e6e1846/servers/e8020a03-5cd9-4f8c-b2d8-9972a256cf6a",
                  "identity-url":"http://10.0.14.1:9005/api/multicloud-titanium_cloud/v0/pod25_RegionOne/identity/v2.0"
            }
      }
}

Code Block

language	js
theme	Confluence
title	APPC Provider - VM Snapshot
linenumbers	true
collapse	true

{
      "input":{
            "common-request-header":{
                  "service-request-id":"1"
            },
            "vnf-resource":{
                  "vm-id":"http://10.0.14.1:80/api/multicloud-titanium_cloud/v0/pod25_RegionOne/compute/v2.1/cf142fb96ce24770946c0f7117c0aeb3/servers/60be808f-5d45-4a60-a578-9c0c6ee6be08",
                  "identity-url":"http://10.0.14.1:9005/api/multicloud-titanium_cloud/v0/pod25_RegionOne/identity/v2.0"
            }
      }
}

Code Block

language	js
title	APPC Provider - ModifyConfig
collapse	true

{
"input": {
    "common-request-header": {
        "service-request-id": "1"
    },
    "config-payload": {
        "config-url": "5f517fd4-bf3d-43bc-8147-1b61776d7ded",
        "config-json": "{\"pg-streams\":{\"pg-stream\": [{ \"id\": \"fw_udp1\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp2\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp3\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp4\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp5\", \"is-enabled\": \"true\" }]}}"
    }
}
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VNF Restart
linenumbers	true
collapse	true

{  
    "input": {
      "common-header": {
        "timestamp": "2017-10-25T11:10:04.244Z",
        "api-ver": "2.00",
        "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "sub-request-id": "1",
        "flags": {
            "force" : "TRUE",
            "ttl" : 60000
        }
      },
      "action": "Restart",
      "action-identifiers": {
        "vnf-id": "vCPE_Infrastructure_vGMUX_demo_app"
      }
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VNF Stop
linenumbers	true
collapse	true

{  
    "input": {
      "common-header": {
        "timestamp": "2017-10-25T14:50:04.244Z",
        "api-ver": "2.00",
        "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "sub-request-id": "1",
        "flags": {
                    "force" : "TRUE",
                    "ttl" : 60000
        }
      },
      "action": "Stop",
      "action-identifiers": {
        "vnf-id": "vCPE_Infrastructure_vGMUX_demo_app"
      }
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VNF Stop
linenumbers	true
collapse	true

{  
    "input": {
      "common-header": {
        "timestamp": "2017-10-25T14:50:04.244Z",
        "api-ver": "2.00",
        "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "sub-request-id": "1",
        "flags": {
                    "force" : "TRUE",
                    "ttl" : 60000
        }
      },
      "action": "Stop",
      "action-identifiers": {
        "vnf-id": "vFirewall_demo_app"
      }
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VNF Restart via DGOrchestrator/DMaaP
linenumbers	true
collapse	true

{
    "version": "2.00",
    "rpc-name": "restart",
    "correlation-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0-1",
    "type": "request",
    "body": {
        "input": {
            "common-header": {
                "timestamp": "2017-11-03T17:34:04.244Z",
                "api-ver": "2.05",
                "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
                "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
                "sub-request-id": "1",
                "flags": {
                    "force": "TRUE",
                    "ttl": 60000
                }
            },
            "action": "Restart",
            "action-identifiers": {
                "vnf-id": "APPC_Test_VM"
            }
        }
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VNF Restart via DGOrchestrator
linenumbers	true
collapse	true

{  
    "input": {
      "common-header": {
        "timestamp": "2017-11-1T11:37:04.244Z",
        "api-ver": "2.05",
        "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "sub-request-id": "1",
        "flags": {
            "force" : "TRUE",
            "ttl" : 60000
        }
      },
      "action": "Restart",
      "action-identifiers": {
        "vnf-id": "vFirewall_demo_app"
      }
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VNF Restart via DGOrchestrator
linenumbers	true
collapse	true

{  
    "input": {
      "common-header": {
        "timestamp": "2017-11-1T11:37:04.244Z",
        "api-ver": "2.05",
        "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "sub-request-id": "1",
        "flags": {
            "force" : "TRUE",
            "ttl" : 60000
        }
      },
      "action": "Restart",
      "action-identifiers": {
        "vnf-id": "vCPE_Infrastructure_vGMUX_demo_app"
      }
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VM Stop via DGOrchestrator
linenumbers	true
collapse	true

{
    "input": {
        "common-header": {
            "timestamp": "2017-10-31T15:02:04.244Z",
            "api-ver": "2.05",
            "originator-id": "SDNGP",
            "request-id": "Stop_VM-vFirewall_demo_app",
            "sub-request-id": "Stop_VM-vFirewall_demo_app",
            "flags": {
                "mode": "NORMAL",
                "force": "TRUE",
                "ttl": 36000
            }
        },
        "action": "Stop",
        "action-identifiers": {
            "vnf-id": "vFirewall_demo_app",
            "vserver-id": "5b06cf36-40a0-4bcb-bde9-849aa4702d67"
        },
        "payload": "{\"vm-id\":\"http://10.12.25.2:8774/v2.1/466979b815b5415ba14ada713e6e1846/servers/5b06cf36-40a0-4bcb-bde9-849aa4702d67\", \"identity-url\": \"http://10.12.25.2:5000/v3\",\"skip-hypervisor-check\":\"true\"}"
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VM Start via DGOrchestrator
linenumbers	true
collapse	true

{
    "input": {
        "common-header": {
            "timestamp": "2017-10-31T15:02:04.244Z",
            "api-ver": "2.05",
            "originator-id": "SDNGP",
            "request-id": "Stop_VM-vFirewall_demo_app",
            "sub-request-id": "Stop_VM-vFirewall_demo_app",
            "flags": {
                "mode": "NORMAL",
                "force": "TRUE",
                "ttl": 36000
            }
        },
        "action": "Start",
        "action-identifiers": {
            "vnf-id": "vFirewall_demo_app",
            "vserver-id": "5b06cf36-40a0-4bcb-bde9-849aa4702d67"
        },
        "payload": "{\"vm-id\":\"http://10.12.25.2:8774/v2.1/466979b815b5415ba14ada713e6e1846/servers/5b06cf36-40a0-4bcb-bde9-849aa4702d67\", \"identity-url\": \"http://10.12.25.2:5000/v3\",\"skip-hypervisor-check\":\"true\"}"
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VM Rebuild via DGOrchestrator
linenumbers	true
collapse	true

{
    "input": {
        "common-header": {
            "timestamp": "2017-10-31T15:02:04.244Z",
            "api-ver": "2.05",
            "originator-id": "SDNGP",
            "request-id": "Stop_VM-vFirewall_demo_app",
            "sub-request-id": "Stop_VM-vFirewall_demo_app",
            "flags": {
                "mode": "NORMAL",
                "force": "TRUE",
                "ttl": 36000
            }
        },
        "action": "Rebuild",
        "action-identifiers": {
            "vnf-id": "vFirewall_demo_app",
            "vserver-id": "60be808f-5d45-4a60-a578-9c0c6ee6be08"
        },
        "payload": "{\"vm-id\":\"http://10.12.25.2:8774/v2.1/466979b815b5415ba14ada713e6e1846/servers/5b06cf36-40a0-4bcb-bde9-849aa4702d67\", \"identity-url\": \"http://10.12.25.2:5000/v3\",\"skip-hypervisor-check\":\"true\"}"
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VM Stop via DGOrchestrator
linenumbers	true
collapse	true

{
    "input": {
        "common-header": {
            "timestamp": "2017-10-31T15:02:04.244Z",
            "api-ver": "2.05",
            "originator-id": "SDNGP",
            "request-id": "Stop_VM-vCPE_Infrastructure_vGMUX_demo_app",
            "sub-request-id": "Stop_VM-vCPE_Infrastructure_vGMUX_demo_app",
            "flags": {
                "mode": "NORMAL",
                "force": "TRUE",
                "ttl": 36000
            }
        },
        "action": "Stop",
        "action-identifiers": {
            "vnf-id": "vCPE_Infrastructure_vGMUX_demo_app",
            "vserver-id": "e8020a03-5cd9-4f8c-b2d8-9972a256cf6a"
        },
        "payload": "{\"vm-id\":\"http://10.0.14.1:80/api/multicloud-titanium_cloud/v0/pod25_RegionOne/compute/v2.1/466979b815b5415ba14ada713e6e1846/servers/e8020a03-5cd9-4f8c-b2d8-9972a256cf6a\", \"identity-url\": \"http://10.0.14.1:9005/api/multicloud-titanium_cloud/v0/pod25_RegionOne/identity/v2.0\",\"skip-hypervisor-check\":\"true\"}"
    }
}

Code Block

language	js
theme	Confluence
title	LCM Provider - VM Start via DGOrchestrator
linenumbers	true
collapse	true

{
    "input": {
        "common-header": {
            "timestamp": "2017-10-31T15:02:04.244Z",
            "api-ver": "2.05",
            "originator-id": "SDNGP",
            "request-id": "Stop_VM-vCPE_Infrastructure_vGMUX_demo_app",
            "sub-request-id": "Stop_VM-vCPE_Infrastructure_vGMUX_demo_app",
            "flags": {
                "mode": "NORMAL",
                "force": "TRUE",
                "ttl": 36000
            }
        },
        "action": "Start",
        "action-identifiers": {
            "vnf-id": "vCPE_Infrastructure_vGMUX_demo_app",
            "vserver-id": "e8020a03-5cd9-4f8c-b2d8-9972a256cf6a"
        },
        "payload": "{\"vm-id\":\"http://10.0.14.1:80/api/multicloud-titanium_cloud/v0/pod25_RegionOne/compute/v2.1/466979b815b5415ba14ada713e6e1846/servers/e8020a03-5cd9-4f8c-b2d8-9972a256cf6a\", \"identity-url\": \"http://10.0.14.1:9005/api/multicloud-titanium_cloud/v0/pod25_RegionOne/identity/v2.0\",\"skip-hypervisor-check\":\"true\"}"
    }
}

Code Block

title	APPC Provider - vFW PacketGenerator PGStreams ModifyConfig
collapse	true

{
"input": {
    "common-request-header": {
        "service-request-id": "1"
    },
    "config-payload": {
        "config-url": "5f517fd4-bf3d-43bc-8147-1b61776d7ded",
        "config-json": "{\"pg-streams\":{\"pg-stream\": [{ \"id\": \"fw_udp1\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp2\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp3\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp4\", \"is-enabled\": \"true\" }, { \"id\": \"fw_udp5\", \"is-enabled\": \"true\" }]}}"
    }
}
}

Code Block

title	LCM Provider - config-modify
collapse	true

{
"input": {
	"common-header": {
		"timestamp": "2017-10-25T11:10:04.244Z",
		"api-ver": "2.00",
		"originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
		"request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
		"sub-request-id": "1",
		"flags": {
			"force": "TRUE",
			"ttl": 60000
		}
	},
	"action": "ConfigModify",
	"action-identifiers": {
		"vnf-id": "<VNF_ID>"
	},
	"payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",\"config-json\": \"{\"pg-streams\":{\"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" }, {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" }, { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },{ \"id\":\"fw_udp4\", \"is-enabled\": \"true\" }, {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
	}
}

Code Block

title	CongiScaleOut via APPC API Doc Explorer
collapse	true

{
    "input": {
        "common-header": {
            "timestamp": "2018-05-16T17:03:30.44Z",
            "api-ver": "2.00",
            "originator-id": "SDNGP",
            "request-id": "ScaleOut_RB3_16th May_TC3",
            "sub-request-id": "ScaleOut_RB3_16th May_TC3",
            "flags": {
                "force": "TRUE",
                "ttl": 12000
            }
        },
        "action": "ConfigScaleOut",
        "action-identifiers": {
            "vnf-id": "APPC-test-vLB"
        },
        "payload": "{\"request-parameters\":{\"vnf-host-ip-address\":\"10.12.6.195\",\"vf-module-id\": \"zdfw1lb01lb01\",\"controller-template-id\": \"vLB\"},\"configuration-parameters\":{\"ip-addr\":\"192.168.10.212\", \"oam-ip-addr\":\"10.0.150.4\",\"enabled\":\"true\"}}"
    }
}

Code Block

title	ConfigScaleOut via DMaaP
collapse	true

{
        "version": "2.00",
        "rpc-name": "config-scale-out",
        "correlation-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0-10",
        "type": "request",
        "body": {
                "input": {
                        "common-header": {
                                "timestamp": "2018-05-16T17:25:30.44Z",
                                "api-ver": "2.00",
                                "originator-id": "SDNGP",
                                "request-id": "ScaleOut_RB3_16th May_TC3",
                                "sub-request-id": "ScaleOut_RB3_16th May_TC3",
                                "flags": {
                                        "force": "TRUE",
                                        "ttl": 60000
                                }
                        },
                        "action": "ConfigScaleOut",
                        "action-identifiers": {
                                "vnf-id": "APPC-test-vLB"
                        },
                        "payload": "{\"request-parameters\":{\"vnf-host-ip-address\":\"10.12.6.195\",\"vf-module-id\": \"zdfw1lb01lb01\",\"controller-template-id\": \"vLB\"},\"configuration-parameters\":{\"ip-addr\":\"192.168.10.212\", \"oam-ip-addr\":\"10.0.150.4\",\"enabled\":\"true\"}}"
                }
        }
}

Versions Compared

Old Version 12

New Version 13

Key