rw-pkg-mgmt - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwPkgMgmt_RwPkgMgmt_t_schema
Global Schema Pointer	rw_ypbc_RwPkgMgmt_RwPkgMgmt_g_schema

rw-pkg-mgmt data

rw-pkg-mgmt:download-jobs

Download jobs

Key Identifiers:

XPath Path	/rw-pkg-mgmt:download-jobs
XPath Keyed Path	/rw-pkg-mgmt:download-jobs
RW.REST URI Path	/rw-pkg-mgmt:download-jobs

Fields

Name	Type	Description
job	LIST

JSON Sample

{
  "job": [
    {
      "download-id": "STRING",
      "url": "STRING",
      "package-type": "NSD",
      "package-id": "STRING",
      "package-path": "STRING",
      "status": "QUEUED",
      "detail": "STRING",
      "progress-percent": 0,
      "bytes_downloaded": 0,
      "bytes_total": 0,
      "bytes_per_second": 0,
      "start-time": 0,
      "stop-time": 0
    }, {
      ...
    }
  ]
}

XML Sample

<rw-pkg-mgmt:download-jobs xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:job>
    <rw-pkg-mgmt:download-id>STRING</rw-pkg-mgmt:download-id>
    <rw-pkg-mgmt:url>STRING</rw-pkg-mgmt:url>
    <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
    <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
    <rw-pkg-mgmt:package-path>STRING</rw-pkg-mgmt:package-path>
    <rw-pkg-mgmt:status>QUEUED</rw-pkg-mgmt:status>
    <rw-pkg-mgmt:detail>STRING</rw-pkg-mgmt:detail>
    <rw-pkg-mgmt:progress-percent>0</rw-pkg-mgmt:progress-percent>
    <rw-pkg-mgmt:bytes_downloaded>0</rw-pkg-mgmt:bytes_downloaded>
    <rw-pkg-mgmt:bytes_total>0</rw-pkg-mgmt:bytes_total>
    <rw-pkg-mgmt:bytes_per_second>0</rw-pkg-mgmt:bytes_per_second>
    <rw-pkg-mgmt:start-time>0</rw-pkg-mgmt:start-time>
    <rw-pkg-mgmt:stop-time>0</rw-pkg-mgmt:stop-time>
  </rw-pkg-mgmt:job>
</rw-pkg-mgmt:download-jobs>

rw-pkg-mgmt:job

Key Identifiers:

XPath Path	/rw-pkg-mgmt:download-jobs/rw-pkg-mgmt:job
XPath Keyed Path	/rw-pkg-mgmt:download-jobs/rw-pkg-mgmt:job[rw-pkg-mgmt:download-id='STRING']
RW.REST URI Path	/rw-pkg-mgmt:download-jobs/job/STRING

Fields

Name	Type	Description
download-id	STRING	Unique UUID
url	STRING	URL of the download
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
package-path	STRING	Relative path in the package
status	ENUM	The status of the download task
detail	STRING	Detailed download status message
progress-percent	UINT8	The download progress percentage (0-100)
bytes_downloaded	UINT64	The number of bytes downloaded
bytes_total	UINT64	The total number of bytes to write
bytes_per_second	UINT32	The total number of bytes written per second
start-time	UINT32	start time (unix epoch)
stop-time	UINT32	stop time (unix epoch)

JSON Sample

[
  {
    "download-id": "STRING",
    "url": "STRING",
    "package-type": "NSD",
    "package-id": "STRING",
    "package-path": "STRING",
    "status": "QUEUED",
    "detail": "STRING",
    "progress-percent": 0,
    "bytes_downloaded": 0,
    "bytes_total": 0,
    "bytes_per_second": 0,
    "start-time": 0,
    "stop-time": 0
  }, {
    ...
  }
]

XML Sample

<rw-pkg-mgmt:job xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:download-id>STRING</rw-pkg-mgmt:download-id>
  <rw-pkg-mgmt:url>STRING</rw-pkg-mgmt:url>
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:package-path>STRING</rw-pkg-mgmt:package-path>
  <rw-pkg-mgmt:status>QUEUED</rw-pkg-mgmt:status>
  <rw-pkg-mgmt:detail>STRING</rw-pkg-mgmt:detail>
  <rw-pkg-mgmt:progress-percent>0</rw-pkg-mgmt:progress-percent>
  <rw-pkg-mgmt:bytes_downloaded>0</rw-pkg-mgmt:bytes_downloaded>
  <rw-pkg-mgmt:bytes_total>0</rw-pkg-mgmt:bytes_total>
  <rw-pkg-mgmt:bytes_per_second>0</rw-pkg-mgmt:bytes_per_second>
  <rw-pkg-mgmt:start-time>0</rw-pkg-mgmt:start-time>
  <rw-pkg-mgmt:stop-time>0</rw-pkg-mgmt:stop-time>
</rw-pkg-mgmt:job>

rw-pkg-mgmt:copy-jobs

Copy jobs

Key Identifiers:

XPath Path	/rw-pkg-mgmt:copy-jobs
XPath Keyed Path	/rw-pkg-mgmt:copy-jobs
RW.REST URI Path	/rw-pkg-mgmt:copy-jobs

Fields

Name	Type	Description
job	LIST

JSON Sample

{
  "job": [
    {
      "transaction-id": "STRING",
      "status": "QUEUED"
    }, {
      ...
    }
  ]
}

XML Sample

<rw-pkg-mgmt:copy-jobs xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:job>
    <rw-pkg-mgmt:transaction-id>STRING</rw-pkg-mgmt:transaction-id>
    <rw-pkg-mgmt:status>QUEUED</rw-pkg-mgmt:status>
  </rw-pkg-mgmt:job>
</rw-pkg-mgmt:copy-jobs>

rw-pkg-mgmt:job

Key Identifiers:

XPath Path	/rw-pkg-mgmt:copy-jobs/rw-pkg-mgmt:job
XPath Keyed Path	/rw-pkg-mgmt:copy-jobs/rw-pkg-mgmt:job[rw-pkg-mgmt:transaction-id='STRING']
RW.REST URI Path	/rw-pkg-mgmt:copy-jobs/job/STRING

Fields

Name	Type	Description
transaction-id	STRING	Unique UUID
status	ENUM	The status of the copy task

JSON Sample

[
  {
    "transaction-id": "STRING",
    "status": "QUEUED"
  }, {
    ...
  }
]

XML Sample

<rw-pkg-mgmt:job xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:transaction-id>STRING</rw-pkg-mgmt:transaction-id>
  <rw-pkg-mgmt:status>QUEUED</rw-pkg-mgmt:status>
</rw-pkg-mgmt:job>

rw-pkg-mgmt rpc input

rw-pkg-mgmt:get-package-endpoint

Key Identifiers:

XPath Path	/rw-pkg-mgmt:get-package-endpoint
XPath Keyed Path	/rw-pkg-mgmt:get-package-endpoint
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:package-copy

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-copy
XPath Keyed Path	/rw-pkg-mgmt:package-copy
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
package-name	STRING	Name of destination package

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING",
  "package-name": "STRING"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:package-name>STRING</rw-pkg-mgmt:package-name>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:get-package-schema

Key Identifiers:

XPath Path	/rw-pkg-mgmt:get-package-schema
XPath Keyed Path	/rw-pkg-mgmt:get-package-schema
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package

JSON Sample

{
  "package-type": "NSD"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:package-create

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-create
XPath Keyed Path	/rw-pkg-mgmt:package-create
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
external-url	STRING	Url to download
username	STRING	username if the url uses authentication
password	STRING	password if the url uses authentication

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING",
  "external-url": "STRING",
  "username": "STRING",
  "password": "STRING"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:external-url>STRING</rw-pkg-mgmt:external-url>
  <rw-pkg-mgmt:username>STRING</rw-pkg-mgmt:username>
  <rw-pkg-mgmt:password>STRING</rw-pkg-mgmt:password>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:package-update

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-update
XPath Keyed Path	/rw-pkg-mgmt:package-update
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
external-url	STRING	Url to download
username	STRING	username if the url uses authentication
password	STRING	password if the url uses authentication

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING",
  "external-url": "STRING",
  "username": "STRING",
  "password": "STRING"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:external-url>STRING</rw-pkg-mgmt:external-url>
  <rw-pkg-mgmt:username>STRING</rw-pkg-mgmt:username>
  <rw-pkg-mgmt:password>STRING</rw-pkg-mgmt:password>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:package-export

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-export
XPath Keyed Path	/rw-pkg-mgmt:package-export
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
export-schema	ENUM	Schema to export
export-grammar	ENUM	Schema to export
export-format	ENUM	Format to export

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING",
  "export-schema": "RIFT",
  "export-grammar": "OSM",
  "export-format": "YAML"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:export-schema>RIFT</rw-pkg-mgmt:export-schema>
  <rw-pkg-mgmt:export-grammar>OSM</rw-pkg-mgmt:export-grammar>
  <rw-pkg-mgmt:export-format>YAML</rw-pkg-mgmt:export-format>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:package-file-add

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-file-add
XPath Keyed Path	/rw-pkg-mgmt:package-file-add
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
package-path	STRING	Relative path in the package
external-url	STRING	Url to download
username	STRING	username if the url uses authentication
password	STRING	password if the url uses authentication
vnfd-file-type	ENUM	Type of vnfd file being added to the package
nsd-file-type	ENUM	Type of nsd file being added to the package

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING",
  "package-path": "STRING",
  "external-url": "STRING",
  "username": "STRING",
  "password": "STRING",
  "vnfd-file-type": "ICONS",
  "nsd-file-type": "VNF_CONFIG"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:package-path>STRING</rw-pkg-mgmt:package-path>
  <rw-pkg-mgmt:external-url>STRING</rw-pkg-mgmt:external-url>
  <rw-pkg-mgmt:username>STRING</rw-pkg-mgmt:username>
  <rw-pkg-mgmt:password>STRING</rw-pkg-mgmt:password>
  <rw-pkg-mgmt:vnfd-file-type>ICONS</rw-pkg-mgmt:vnfd-file-type>
  <rw-pkg-mgmt:nsd-file-type>VNF_CONFIG</rw-pkg-mgmt:nsd-file-type>
</rw-pkg-mgmt:input>

rw-pkg-mgmt:package-file-delete

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-file-delete
XPath Keyed Path	/rw-pkg-mgmt:package-file-delete
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM	Type of the package
package-id	STRING	Id of the package
package-path	STRING	Relative path in the package
vnfd-file-type	ENUM	Type of file being removed from the vnfd package
nsd-file-type	ENUM	Type of file being removed from the nsd package

JSON Sample

{
  "package-type": "NSD",
  "package-id": "STRING",
  "package-path": "STRING",
  "vnfd-file-type": "ICONS",
  "nsd-file-type": "VNF_CONFIG"
}

XML Sample

<rw-pkg-mgmt:input xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
  <rw-pkg-mgmt:package-path>STRING</rw-pkg-mgmt:package-path>
  <rw-pkg-mgmt:vnfd-file-type>ICONS</rw-pkg-mgmt:vnfd-file-type>
  <rw-pkg-mgmt:nsd-file-type>VNF_CONFIG</rw-pkg-mgmt:nsd-file-type>
</rw-pkg-mgmt:input>

rw-pkg-mgmt rpc output

rw-pkg-mgmt:get-package-endpoint

Key Identifiers:

XPath Path	/rw-pkg-mgmt:get-package-endpoint
XPath Keyed Path	/rw-pkg-mgmt:get-package-endpoint
RW.REST URI Path	/output

Fields

Name	Type	Description
endpoint	STRING	Endpoint that contains all the package-related data

JSON Sample

{
  "endpoint": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:endpoint>STRING</rw-pkg-mgmt:endpoint>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:package-copy

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-copy
XPath Keyed Path	/rw-pkg-mgmt:package-copy
RW.REST URI Path	/output

Fields

Name	Type	Description
transaction-id	STRING	Valid ID to track the status of the task
package-type	ENUM	Type of the package
package-id	STRING	Id of the package

JSON Sample

{
  "transaction-id": "STRING",
  "package-type": "NSD",
  "package-id": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:transaction-id>STRING</rw-pkg-mgmt:transaction-id>
  <rw-pkg-mgmt:package-type>NSD</rw-pkg-mgmt:package-type>
  <rw-pkg-mgmt:package-id>STRING</rw-pkg-mgmt:package-id>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:get-package-schema

Key Identifiers:

XPath Path	/rw-pkg-mgmt:get-package-schema
XPath Keyed Path	/rw-pkg-mgmt:get-package-schema
RW.REST URI Path	/output

Fields

Name	Type	Description
schema	LEAF_LIST	List of all top level directories for the package.

JSON Sample

{
  "schema": [ "STRING", ... ]
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:schema>STRING</rw-pkg-mgmt:schema>
  <rw-pkg-mgmt:schema>...</rw-pkg-mgmt:schema>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:schema

List of all top level directories for the package.

Key Identifiers:

XPath Path	/rw-pkg-mgmt:get-package-schema/rw-pkg-mgmt:schema
XPath Keyed Path	/rw-pkg-mgmt:get-package-schema/rw-pkg-mgmt:schema
RW.REST URI Path	/output/schema

JSON Sample

[ "STRING", ... ]

XML Sample

<rw-pkg-mgmt:schema xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">STRING</rw-pkg-mgmt:schema>
<rw-pkg-mgmt:schema xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">...</rw-pkg-mgmt:schema>

rw-pkg-mgmt:package-create

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-create
XPath Keyed Path	/rw-pkg-mgmt:package-create
RW.REST URI Path	/output

Fields

Name	Type	Description
transaction-id	STRING	Valid ID to track the status of the task

JSON Sample

{
  "transaction-id": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:transaction-id>STRING</rw-pkg-mgmt:transaction-id>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:package-update

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-update
XPath Keyed Path	/rw-pkg-mgmt:package-update
RW.REST URI Path	/output

Fields

Name	Type	Description
transaction-id	STRING	Valid ID to track the status of the task

JSON Sample

{
  "transaction-id": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:transaction-id>STRING</rw-pkg-mgmt:transaction-id>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:package-export

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-export
XPath Keyed Path	/rw-pkg-mgmt:package-export
RW.REST URI Path	/output

Fields

Name	Type	Description
transaction-id	STRING	Valid ID to track the status of the task
filename	STRING	Valid ID to track the status of the task

JSON Sample

{
  "transaction-id": "STRING",
  "filename": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:transaction-id>STRING</rw-pkg-mgmt:transaction-id>
  <rw-pkg-mgmt:filename>STRING</rw-pkg-mgmt:filename>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:package-file-add

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-file-add
XPath Keyed Path	/rw-pkg-mgmt:package-file-add
RW.REST URI Path	/output

Fields

Name	Type	Description
task-id	STRING	Valid ID to track the status of the task

JSON Sample

{
  "task-id": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:task-id>STRING</rw-pkg-mgmt:task-id>
</rw-pkg-mgmt:output>

rw-pkg-mgmt:package-file-delete

Key Identifiers:

XPath Path	/rw-pkg-mgmt:package-file-delete
XPath Keyed Path	/rw-pkg-mgmt:package-file-delete
RW.REST URI Path	/output

Fields

Name	Type	Description
status	STRING	Status of the delte operation
error-trace	STRING	Trace in case of a failure

JSON Sample

{
  "status": "STRING",
  "error-trace": "STRING"
}

XML Sample

<rw-pkg-mgmt:output xmlns:rw-pkg-mgmt="http://riftio.com/ns/riftware-1.0/rw-pkg-mgmt">
  <rw-pkg-mgmt:status>STRING</rw-pkg-mgmt:status>
  <rw-pkg-mgmt:error-trace>STRING</rw-pkg-mgmt:error-trace>
</rw-pkg-mgmt:output>