rw-project - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Rwmon_RwProject_t_schema
Global Schema Pointer	rw_ypbc_Rwmon_RwProject_g_schema

rw-project data

This yang module defines project-based tenancy for RIFT.ware. Authorization for project access is defined in terms of RIFT.ware's Role-Based Access Control (RBAC) model.

rw-project:project

Configuration and state for individual projects. RIFT.ware applications and projects are expected to augment this list in order to add configuration for projects that is specific to the product or application. As such, this list contains minimal data defined in this yang module. When augmenting this element, other yang modules should prefer to define containers with the same name as the augmenting module. (Augmenting RIFT.ware modules should prefer to augment without the rw prefix [for new features], or should prefer to augment the augmented container of an existing augment, to ease future adoption and/or standardization.)

Key Identifiers:

XPath Path	/rw-project:project
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']
RW.REST URI Path	/rw-project:project/STRING

Fields

Name	Type	Description
name	STRING	Name of the project.
description	STRING	Information about project
project-config	CONTAINER	General Project configuration supported by all products.
project-state	CONTAINER	General Project operational state supported by all products.
nfvi-metrics	CONTAINER
alarm	CONTAINER

JSON Config Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "rwmon:nfvi-metrics": {
      "timestamp": 0.0,
      "vcpu": { ... },
      "memory": { ... },
      "storage": { ... },
      "external-ports": { ... },
      "internal-ports": { ... },
      "network": { ... }
    },
    "rwmon:alarm": {
      "alarm-id": "STRING",
      "name": "STRING",
      "description": "STRING",
      "vdur-id": "STRING",
      "actions": { ... },
      "repeat": true,
      "enabled": true,
      "severity": "LOW",
      "metric": "CPU_UTILIZATION",
      "statistic": "AVERAGE",
      "operation": "GE",
      "value": 0.0,
      "period": 0,
      "evaluations": 0
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "project-state": {
      "user": [ { ... }, { ... } ],
      "role": [ { ... }, { ... } ]
    },
    "rwmon:nfvi-metrics": {
      "timestamp": 0.0,
      "vcpu": { ... },
      "memory": { ... },
      "storage": { ... },
      "external-ports": { ... },
      "internal-ports": { ... },
      "network": { ... }
    },
    "rwmon:alarm": {
      "alarm-id": "STRING",
      "name": "STRING",
      "description": "STRING",
      "vdur-id": "STRING",
      "actions": { ... },
      "repeat": true,
      "enabled": true,
      "severity": "LOW",
      "metric": "CPU_UTILIZATION",
      "statistic": "AVERAGE",
      "operation": "GE",
      "value": 0.0,
      "period": 0,
      "evaluations": 0
    }
  }, {
    ...
  }
]

XML Config Sample

<rw-project:project xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:name>STRING</rw-project:name>
  <rw-project:description>STRING</rw-project:description>
  <rw-project:project-config>
    <rw-project:user>...</rw-project:user>
  </rw-project:project-config>
  <rwmon:nfvi-metrics xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
    <rwmon:timestamp>0.0</rwmon:timestamp>
    <rwmon:vcpu>...</rwmon:vcpu>
    <rwmon:memory>...</rwmon:memory>
    <rwmon:storage>...</rwmon:storage>
    <rwmon:external-ports>...</rwmon:external-ports>
    <rwmon:internal-ports>...</rwmon:internal-ports>
    <rwmon:network>...</rwmon:network>
  </rwmon:nfvi-metrics>
  <rwmon:alarm xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
    <rwmon:alarm-id>STRING</rwmon:alarm-id>
    <rwmon:name>STRING</rwmon:name>
    <rwmon:description>STRING</rwmon:description>
    <rwmon:vdur-id>STRING</rwmon:vdur-id>
    <rwmon:actions>...</rwmon:actions>
    <rwmon:repeat>true</rwmon:repeat>
    <rwmon:enabled>true</rwmon:enabled>
    <rwmon:severity>LOW</rwmon:severity>
    <rwmon:metric>CPU_UTILIZATION</rwmon:metric>
    <rwmon:statistic>AVERAGE</rwmon:statistic>
    <rwmon:operation>GE</rwmon:operation>
    <rwmon:value>0.0</rwmon:value>
    <rwmon:period>0</rwmon:period>
    <rwmon:evaluations>0</rwmon:evaluations>
  </rwmon:alarm>
</rw-project:project>

XML Sample

<rw-project:project xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:name>STRING</rw-project:name>
  <rw-project:description>STRING</rw-project:description>
  <rw-project:project-config>
    <rw-project:user>...</rw-project:user>
  </rw-project:project-config>
  <rw-project:project-state>
    <rw-project:user>...</rw-project:user>
    <rw-project:role>...</rw-project:role>
  </rw-project:project-state>
  <rwmon:nfvi-metrics xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
    <rwmon:timestamp>0.0</rwmon:timestamp>
    <rwmon:vcpu>...</rwmon:vcpu>
    <rwmon:memory>...</rwmon:memory>
    <rwmon:storage>...</rwmon:storage>
    <rwmon:external-ports>...</rwmon:external-ports>
    <rwmon:internal-ports>...</rwmon:internal-ports>
    <rwmon:network>...</rwmon:network>
  </rwmon:nfvi-metrics>
  <rwmon:alarm xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
    <rwmon:alarm-id>STRING</rwmon:alarm-id>
    <rwmon:name>STRING</rwmon:name>
    <rwmon:description>STRING</rwmon:description>
    <rwmon:vdur-id>STRING</rwmon:vdur-id>
    <rwmon:actions>...</rwmon:actions>
    <rwmon:repeat>true</rwmon:repeat>
    <rwmon:enabled>true</rwmon:enabled>
    <rwmon:severity>LOW</rwmon:severity>
    <rwmon:metric>CPU_UTILIZATION</rwmon:metric>
    <rwmon:statistic>AVERAGE</rwmon:statistic>
    <rwmon:operation>GE</rwmon:operation>
    <rwmon:value>0.0</rwmon:value>
    <rwmon:period>0</rwmon:period>
    <rwmon:evaluations>0</rwmon:evaluations>
  </rwmon:alarm>
</rw-project:project>

rw-project:project-config

General Project configuration supported by all products.

Key Identifiers:

XPath Path	/rw-project:project/rw-project:project-config
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rw-project:project-config
RW.REST URI Path	/rw-project:project/STRING/project-config

Fields

Name	Type	Description
user	LIST	The list of Users who have been assigned Roles within this Project.

JSON Config Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-project:project-config xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
  </rw-project:user>
</rw-project:project-config>

XML Sample

<rw-project:project-config xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
  </rw-project:user>
</rw-project:project-config>

rw-project:user

The list of Users who have been assigned Roles within this Project.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-config/rw-project:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-config/user/STRING,STRING

Fields

Name	Type	Description
user-domain	LEAFREF	The user domain. This is the source of the user identity. Different domains may duplicate a user-name, but such users would be considered distinct by RIFT.ware.
user-name	LEAFREF	The user name. The syntax of this name depends on the domain. For example, if the domain is a login name, it might be limited to alphanumeric characters. However, if the domain is email address, the syntax could include additional characters, such as the at(@) sign.
role	LIST	The list of Roles the User has been assigned.

JSON Config Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
  </rw-project:role>
</rw-project:user>

XML Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
  </rw-project:role>
</rw-project:user>

rw-project:role

The list of Roles the User has been assigned.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-config/rw-project:user/rw-project:role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-config/user/STRING,STRING/role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
</rw-project:role>

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
</rw-project:role>

rw-project:project-state

General Project operational state supported by all products.

Key Identifiers:

XPath Path	/rw-project:project/rw-project:project-state
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rw-project:project-state
RW.REST URI Path	/rw-project:project/STRING/project-state

Fields

Name	Type	Description
user	LIST	The state of Users who have been assigned Roles within this Project.
role	LIST	The set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role.

JSON Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "role": [
    {
      "role": "STRING",
      "description": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<rw-project:project-state xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
  </rw-project:user>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
    <rw-project:description>STRING</rw-project:description>
  </rw-project:role>
</rw-project:project-state>

rw-project:user

The state of Users who have been assigned Roles within this Project.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/user/STRING,STRING

Fields

Name	Type	Description
user-domain	STRING	The user domain. This is the source of the user identity. Different domains may duplicate a user-name, but such users would be considered distinct by RIFT.ware.
user-name	STRING	The user name. The syntax of this name depends on the domain. For example, if the domain is a login name, it might be limited to alphanumeric characters. However, if the domain is some kind of email address, the syntax could include assitional characters, such as the at sign.
role	LIST	The state of the Roles the User has been assigned.

JSON Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING",
        "state": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
    <rw-project:state>STRING</rw-project:state>
  </rw-project:role>
</rw-project:user>

rw-project:role

The state of the Roles the User has been assigned.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:user/rw-project:role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/user/STRING,STRING/role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.
state	STRING	The assignment of a User to a Role may be an asynchronous operation. This value indicates whether the Role assignment is active. If the value is 'active', then the assignment is complete and active. Any other value indicates that Role assignment is in a transitional or failed state, as described in the value.

JSON Sample

[
  {
    "role": "STRING",
    "state": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
  <rw-project:state>STRING</rw-project:state>
</rw-project:role>

rw-project:role

The set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.
description	STRING	A description of the Role.

JSON Sample

[
  {
    "role": "STRING",
    "description": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
  <rw-project:description>STRING</rw-project:description>
</rw-project:role>

rwmon:nfvi-metrics

Key Identifiers:

XPath Path	/rw-project:project/rwmon:nfvi-metrics
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics
RW.REST URI Path	/rw-project:project/STRING/rwmon:nfvi-metrics

Fields

Name	Type	Description
timestamp	DECIMAL64	This is the time when the metric was captured. The timestamp is represented as the number of seconds since the beginning of the Unix epoch.
vcpu	CONTAINER
memory	CONTAINER
storage	CONTAINER
external-ports	CONTAINER
internal-ports	CONTAINER
network	CONTAINER

JSON Config Sample

{
  "timestamp": 0.0,
  "vcpu": {
    "label": "VCPU",
    "total": 0,
    "utilization": 0.0
  },
  "memory": {
    "label": "MEMORY",
    "used": 0,
    "total": 0,
    "utilization": 0.0
  },
  "storage": {
    "label": "STORAGE",
    "used": 0,
    "total": 0,
    "utilization": 0.0
  },
  "external-ports": {
    "label": "EXTERNAL PORTS",
    "total": 0
  },
  "internal-ports": {
    "label": "INTERNAL PORTS",
    "total": 0
  },
  "network": {
    "label": "NETWORK TRAFFIC",
    "incoming": { ... },
    "outgoing": { ... }
  }
}

JSON Sample

{
  "timestamp": 0.0,
  "vcpu": {
    "label": "VCPU",
    "total": 0,
    "utilization": 0.0
  },
  "memory": {
    "label": "MEMORY",
    "used": 0,
    "total": 0,
    "utilization": 0.0
  },
  "storage": {
    "label": "STORAGE",
    "used": 0,
    "total": 0,
    "utilization": 0.0
  },
  "external-ports": {
    "label": "EXTERNAL PORTS",
    "total": 0
  },
  "internal-ports": {
    "label": "INTERNAL PORTS",
    "total": 0
  },
  "network": {
    "label": "NETWORK TRAFFIC",
    "incoming": { ... },
    "outgoing": { ... }
  }
}

XML Config Sample

<rwmon:nfvi-metrics xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:timestamp>0.0</rwmon:timestamp>
  <rwmon:vcpu>
    <rwmon:label>VCPU</rwmon:label>
    <rwmon:total>0</rwmon:total>
    <rwmon:utilization>0.0</rwmon:utilization>
  </rwmon:vcpu>
  <rwmon:memory>
    <rwmon:label>MEMORY</rwmon:label>
    <rwmon:used>0</rwmon:used>
    <rwmon:total>0</rwmon:total>
    <rwmon:utilization>0.0</rwmon:utilization>
  </rwmon:memory>
  <rwmon:storage>
    <rwmon:label>STORAGE</rwmon:label>
    <rwmon:used>0</rwmon:used>
    <rwmon:total>0</rwmon:total>
    <rwmon:utilization>0.0</rwmon:utilization>
  </rwmon:storage>
  <rwmon:external-ports>
    <rwmon:label>EXTERNAL PORTS</rwmon:label>
    <rwmon:total>0</rwmon:total>
  </rwmon:external-ports>
  <rwmon:internal-ports>
    <rwmon:label>INTERNAL PORTS</rwmon:label>
    <rwmon:total>0</rwmon:total>
  </rwmon:internal-ports>
  <rwmon:network>
    <rwmon:label>NETWORK TRAFFIC</rwmon:label>
    <rwmon:incoming>...</rwmon:incoming>
    <rwmon:outgoing>...</rwmon:outgoing>
  </rwmon:network>
</rwmon:nfvi-metrics>

XML Sample

<rwmon:nfvi-metrics xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:timestamp>0.0</rwmon:timestamp>
  <rwmon:vcpu>
    <rwmon:label>VCPU</rwmon:label>
    <rwmon:total>0</rwmon:total>
    <rwmon:utilization>0.0</rwmon:utilization>
  </rwmon:vcpu>
  <rwmon:memory>
    <rwmon:label>MEMORY</rwmon:label>
    <rwmon:used>0</rwmon:used>
    <rwmon:total>0</rwmon:total>
    <rwmon:utilization>0.0</rwmon:utilization>
  </rwmon:memory>
  <rwmon:storage>
    <rwmon:label>STORAGE</rwmon:label>
    <rwmon:used>0</rwmon:used>
    <rwmon:total>0</rwmon:total>
    <rwmon:utilization>0.0</rwmon:utilization>
  </rwmon:storage>
  <rwmon:external-ports>
    <rwmon:label>EXTERNAL PORTS</rwmon:label>
    <rwmon:total>0</rwmon:total>
  </rwmon:external-ports>
  <rwmon:internal-ports>
    <rwmon:label>INTERNAL PORTS</rwmon:label>
    <rwmon:total>0</rwmon:total>
  </rwmon:internal-ports>
  <rwmon:network>
    <rwmon:label>NETWORK TRAFFIC</rwmon:label>
    <rwmon:incoming>...</rwmon:incoming>
    <rwmon:outgoing>...</rwmon:outgoing>
  </rwmon:network>
</rwmon:nfvi-metrics>

rwmon:vcpu

Key Identifiers:

XPath Path	/rw-project:project/rwmon:nfvi-metrics/rwmon:vcpu
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:vcpu
RW.REST URI Path	/rw-project:project/STRING/rwmon:nfvi-metrics/vcpu

Fields

Name	Type	Description
label	STRING	Label to show in UI
total	UINT64	The total number of VCPUs available.
utilization	DECIMAL64	The VCPU utilization (percentage).

JSON Config Sample

{
  "label": "VCPU",
  "total": 0,
  "utilization": 0.0
}

JSON Sample

{
  "label": "VCPU",
  "total": 0,
  "utilization": 0.0
}

XML Config Sample

<rwmon:vcpu xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>VCPU</rwmon:label>
  <rwmon:total>0</rwmon:total>
  <rwmon:utilization>0.0</rwmon:utilization>
</rwmon:vcpu>

XML Sample

<rwmon:vcpu xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>VCPU</rwmon:label>
  <rwmon:total>0</rwmon:total>
  <rwmon:utilization>0.0</rwmon:utilization>
</rwmon:vcpu>

rwmon:memory

Key Identifiers:

XPath Path	/rw-project:project/rwmon:nfvi-metrics/rwmon:memory
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:memory
RW.REST URI Path	/rw-project:project/STRING/rwmon:nfvi-metrics/memory

Fields

Name	Type	Description
label	STRING	Label to show in UI
used	UINT64	The amount of memory (bytes) currently in use.
total	UINT64	The amount of memory (bytes) available.
utilization	DECIMAL64	The memory utilization (percentage).

JSON Config Sample

{
  "label": "MEMORY",
  "used": 0,
  "total": 0,
  "utilization": 0.0
}

JSON Sample

{
  "label": "MEMORY",
  "used": 0,
  "total": 0,
  "utilization": 0.0
}

XML Config Sample

<rwmon:memory xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>MEMORY</rwmon:label>
  <rwmon:used>0</rwmon:used>
  <rwmon:total>0</rwmon:total>
  <rwmon:utilization>0.0</rwmon:utilization>
</rwmon:memory>

XML Sample

<rwmon:memory xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>MEMORY</rwmon:label>
  <rwmon:used>0</rwmon:used>
  <rwmon:total>0</rwmon:total>
  <rwmon:utilization>0.0</rwmon:utilization>
</rwmon:memory>

rwmon:storage

Key Identifiers:

XPath Path	/rw-project:project/rwmon:nfvi-metrics/rwmon:storage
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:storage
RW.REST URI Path	/rw-project:project/STRING/rwmon:nfvi-metrics/storage

Fields

Name	Type	Description
label	STRING	Label to show in UI
used	UINT64	The amount of storage (bytes) currently in use.
total	UINT64	The amount of storage (bytes) available.
utilization	DECIMAL64	The storage utilization (percentage).

JSON Config Sample

{
  "label": "STORAGE",
  "used": 0,
  "total": 0,
  "utilization": 0.0
}

JSON Sample

{
  "label": "STORAGE",
  "used": 0,
  "total": 0,
  "utilization": 0.0
}

XML Config Sample

<rwmon:storage xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>STORAGE</rwmon:label>
  <rwmon:used>0</rwmon:used>
  <rwmon:total>0</rwmon:total>
  <rwmon:utilization>0.0</rwmon:utilization>
</rwmon:storage>

XML Sample

<rwmon:storage xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>STORAGE</rwmon:label>
  <rwmon:used>0</rwmon:used>
  <rwmon:total>0</rwmon:total>
  <rwmon:utilization>0.0</rwmon:utilization>
</rwmon:storage>

rwmon:external-ports

Key Identifiers:

XPath Path

/rw-project:project/rwmon:nfvi-metrics/rwmon:external-ports

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:external-ports

RW.REST URI Path

/rw-project:project/STRING/rwmon:nfvi-metrics/external-ports

Fields

Name	Type	Description
label	STRING	Label to show in UI
total	UINT64	The total number of external ports.

JSON Config Sample

{
  "label": "EXTERNAL PORTS",
  "total": 0
}

JSON Sample

{
  "label": "EXTERNAL PORTS",
  "total": 0
}

XML Config Sample

<rwmon:external-ports xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>EXTERNAL PORTS</rwmon:label>
  <rwmon:total>0</rwmon:total>
</rwmon:external-ports>

XML Sample

<rwmon:external-ports xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>EXTERNAL PORTS</rwmon:label>
  <rwmon:total>0</rwmon:total>
</rwmon:external-ports>

rwmon:internal-ports

Key Identifiers:

XPath Path

/rw-project:project/rwmon:nfvi-metrics/rwmon:internal-ports

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:internal-ports

RW.REST URI Path

/rw-project:project/STRING/rwmon:nfvi-metrics/internal-ports

Fields

Name	Type	Description
label	STRING	Label to show in UI
total	UINT64	The total number of internal ports.

JSON Config Sample

{
  "label": "INTERNAL PORTS",
  "total": 0
}

JSON Sample

{
  "label": "INTERNAL PORTS",
  "total": 0
}

XML Config Sample

<rwmon:internal-ports xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>INTERNAL PORTS</rwmon:label>
  <rwmon:total>0</rwmon:total>
</rwmon:internal-ports>

XML Sample

<rwmon:internal-ports xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>INTERNAL PORTS</rwmon:label>
  <rwmon:total>0</rwmon:total>
</rwmon:internal-ports>

rwmon:network

Key Identifiers:

XPath Path	/rw-project:project/rwmon:nfvi-metrics/rwmon:network
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:network
RW.REST URI Path	/rw-project:project/STRING/rwmon:nfvi-metrics/network

Fields

Name	Type	Description
label	STRING	Label to show in UI
incoming	CONTAINER
outgoing	CONTAINER

JSON Config Sample

{
  "label": "NETWORK TRAFFIC",
  "incoming": {
    "label": "INCOMING NETWORK TRAFFIC",
    "bytes": 0,
    "packets": 0,
    "byte-rate": 0.0,
    "packet-rate": 0.0
  },
  "outgoing": {
    "label": "OUTGOING NETWORK TRAFFIC",
    "bytes": 0,
    "packets": 0,
    "byte-rate": 0.0,
    "packet-rate": 0.0
  }
}

JSON Sample

{
  "label": "NETWORK TRAFFIC",
  "incoming": {
    "label": "INCOMING NETWORK TRAFFIC",
    "bytes": 0,
    "packets": 0,
    "byte-rate": 0.0,
    "packet-rate": 0.0
  },
  "outgoing": {
    "label": "OUTGOING NETWORK TRAFFIC",
    "bytes": 0,
    "packets": 0,
    "byte-rate": 0.0,
    "packet-rate": 0.0
  }
}

XML Config Sample

<rwmon:network xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>NETWORK TRAFFIC</rwmon:label>
  <rwmon:incoming>
    <rwmon:label>INCOMING NETWORK TRAFFIC</rwmon:label>
    <rwmon:bytes>0</rwmon:bytes>
    <rwmon:packets>0</rwmon:packets>
    <rwmon:byte-rate>0.0</rwmon:byte-rate>
    <rwmon:packet-rate>0.0</rwmon:packet-rate>
  </rwmon:incoming>
  <rwmon:outgoing>
    <rwmon:label>OUTGOING NETWORK TRAFFIC</rwmon:label>
    <rwmon:bytes>0</rwmon:bytes>
    <rwmon:packets>0</rwmon:packets>
    <rwmon:byte-rate>0.0</rwmon:byte-rate>
    <rwmon:packet-rate>0.0</rwmon:packet-rate>
  </rwmon:outgoing>
</rwmon:network>

XML Sample

<rwmon:network xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>NETWORK TRAFFIC</rwmon:label>
  <rwmon:incoming>
    <rwmon:label>INCOMING NETWORK TRAFFIC</rwmon:label>
    <rwmon:bytes>0</rwmon:bytes>
    <rwmon:packets>0</rwmon:packets>
    <rwmon:byte-rate>0.0</rwmon:byte-rate>
    <rwmon:packet-rate>0.0</rwmon:packet-rate>
  </rwmon:incoming>
  <rwmon:outgoing>
    <rwmon:label>OUTGOING NETWORK TRAFFIC</rwmon:label>
    <rwmon:bytes>0</rwmon:bytes>
    <rwmon:packets>0</rwmon:packets>
    <rwmon:byte-rate>0.0</rwmon:byte-rate>
    <rwmon:packet-rate>0.0</rwmon:packet-rate>
  </rwmon:outgoing>
</rwmon:network>

rwmon:incoming

Key Identifiers:

XPath Path

/rw-project:project/rwmon:nfvi-metrics/rwmon:network/rwmon:incoming

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:network/rwmon:incoming

RW.REST URI Path

/rw-project:project/STRING/rwmon:nfvi-metrics/network/incoming

Fields

Name	Type	Description
label	STRING	Label to show in UI
bytes	UINT64	The cumulative number of incoming bytes.
packets	UINT64	The cumulative number of incoming packets.
byte-rate	DECIMAL64	The current incoming byte-rate (bytes per second).
packet-rate	DECIMAL64	The current incoming packet (packets per second).

JSON Config Sample

{
  "label": "INCOMING NETWORK TRAFFIC",
  "bytes": 0,
  "packets": 0,
  "byte-rate": 0.0,
  "packet-rate": 0.0
}

JSON Sample

{
  "label": "INCOMING NETWORK TRAFFIC",
  "bytes": 0,
  "packets": 0,
  "byte-rate": 0.0,
  "packet-rate": 0.0
}

XML Config Sample

<rwmon:incoming xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>INCOMING NETWORK TRAFFIC</rwmon:label>
  <rwmon:bytes>0</rwmon:bytes>
  <rwmon:packets>0</rwmon:packets>
  <rwmon:byte-rate>0.0</rwmon:byte-rate>
  <rwmon:packet-rate>0.0</rwmon:packet-rate>
</rwmon:incoming>

XML Sample

<rwmon:incoming xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>INCOMING NETWORK TRAFFIC</rwmon:label>
  <rwmon:bytes>0</rwmon:bytes>
  <rwmon:packets>0</rwmon:packets>
  <rwmon:byte-rate>0.0</rwmon:byte-rate>
  <rwmon:packet-rate>0.0</rwmon:packet-rate>
</rwmon:incoming>

rwmon:outgoing

Key Identifiers:

XPath Path

/rw-project:project/rwmon:nfvi-metrics/rwmon:network/rwmon:outgoing

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:nfvi-metrics/rwmon:network/rwmon:outgoing

RW.REST URI Path

/rw-project:project/STRING/rwmon:nfvi-metrics/network/outgoing

Fields

Name	Type	Description
label	STRING	Label to show in UI
bytes	UINT64	The cumulative number of outgoing bytes.
packets	UINT64	The cumulative number of outgoing packets.
byte-rate	DECIMAL64	The current outgoing byte-rate (bytes per second).
packet-rate	DECIMAL64	The current outgoing packet (packets per second).

JSON Config Sample

{
  "label": "OUTGOING NETWORK TRAFFIC",
  "bytes": 0,
  "packets": 0,
  "byte-rate": 0.0,
  "packet-rate": 0.0
}

JSON Sample

{
  "label": "OUTGOING NETWORK TRAFFIC",
  "bytes": 0,
  "packets": 0,
  "byte-rate": 0.0,
  "packet-rate": 0.0
}

XML Config Sample

<rwmon:outgoing xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>OUTGOING NETWORK TRAFFIC</rwmon:label>
  <rwmon:bytes>0</rwmon:bytes>
  <rwmon:packets>0</rwmon:packets>
  <rwmon:byte-rate>0.0</rwmon:byte-rate>
  <rwmon:packet-rate>0.0</rwmon:packet-rate>
</rwmon:outgoing>

XML Sample

<rwmon:outgoing xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:label>OUTGOING NETWORK TRAFFIC</rwmon:label>
  <rwmon:bytes>0</rwmon:bytes>
  <rwmon:packets>0</rwmon:packets>
  <rwmon:byte-rate>0.0</rwmon:byte-rate>
  <rwmon:packet-rate>0.0</rwmon:packet-rate>
</rwmon:outgoing>

rwmon:alarm

Key Identifiers:

XPath Path	/rw-project:project/rwmon:alarm
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:alarm
RW.REST URI Path	/rw-project:project/STRING/rwmon:alarm

Fields

Name	Type	Description
alarm-id	STRING	This field is reserved for the identifier assigned by the VIM provider
name	STRING	A human readable string to identify the alarm
description	STRING	A description of this alarm
vdur-id	STRING	The identifier of the VDUR that the alarm is associated with
actions	CONTAINER
repeat	BOOLEAN	This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed.
enabled	BOOLEAN	This flag indicates whether the alarm has been enabled or disabled.
severity	ENUM	A measure of the importance or urgency of the alarm
metric	ENUM	The metric to be tracked by this alarm.
statistic	ENUM	The type of metric statistic that is tracked by this alarm
operation	ENUM	The relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value.
value	DECIMAL64	This value defines the threshold that, if crossed, will trigger the alarm.
period	UINT32	The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic.
evaluations	UINT32	Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic.

JSON Config Sample

{
  "alarm-id": "STRING",
  "name": "STRING",
  "description": "STRING",
  "vdur-id": "STRING",
  "actions": {
    "ok": [ { ... }, { ... } ],
    "insufficient-data": [ { ... }, { ... } ],
    "alarm": [ { ... }, { ... } ]
  },
  "repeat": true,
  "enabled": true,
  "severity": "LOW",
  "metric": "CPU_UTILIZATION",
  "statistic": "AVERAGE",
  "operation": "GE",
  "value": 0.0,
  "period": 0,
  "evaluations": 0
}

JSON Sample

{
  "alarm-id": "STRING",
  "name": "STRING",
  "description": "STRING",
  "vdur-id": "STRING",
  "actions": {
    "ok": [ { ... }, { ... } ],
    "insufficient-data": [ { ... }, { ... } ],
    "alarm": [ { ... }, { ... } ]
  },
  "repeat": true,
  "enabled": true,
  "severity": "LOW",
  "metric": "CPU_UTILIZATION",
  "statistic": "AVERAGE",
  "operation": "GE",
  "value": 0.0,
  "period": 0,
  "evaluations": 0
}

XML Config Sample

<rwmon:alarm xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:alarm-id>STRING</rwmon:alarm-id>
  <rwmon:name>STRING</rwmon:name>
  <rwmon:description>STRING</rwmon:description>
  <rwmon:vdur-id>STRING</rwmon:vdur-id>
  <rwmon:actions>
    <rwmon:ok>...</rwmon:ok>
    <rwmon:insufficient-data>...</rwmon:insufficient-data>
    <rwmon:alarm>...</rwmon:alarm>
  </rwmon:actions>
  <rwmon:repeat>true</rwmon:repeat>
  <rwmon:enabled>true</rwmon:enabled>
  <rwmon:severity>LOW</rwmon:severity>
  <rwmon:metric>CPU_UTILIZATION</rwmon:metric>
  <rwmon:statistic>AVERAGE</rwmon:statistic>
  <rwmon:operation>GE</rwmon:operation>
  <rwmon:value>0.0</rwmon:value>
  <rwmon:period>0</rwmon:period>
  <rwmon:evaluations>0</rwmon:evaluations>
</rwmon:alarm>

XML Sample

<rwmon:alarm xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:alarm-id>STRING</rwmon:alarm-id>
  <rwmon:name>STRING</rwmon:name>
  <rwmon:description>STRING</rwmon:description>
  <rwmon:vdur-id>STRING</rwmon:vdur-id>
  <rwmon:actions>
    <rwmon:ok>...</rwmon:ok>
    <rwmon:insufficient-data>...</rwmon:insufficient-data>
    <rwmon:alarm>...</rwmon:alarm>
  </rwmon:actions>
  <rwmon:repeat>true</rwmon:repeat>
  <rwmon:enabled>true</rwmon:enabled>
  <rwmon:severity>LOW</rwmon:severity>
  <rwmon:metric>CPU_UTILIZATION</rwmon:metric>
  <rwmon:statistic>AVERAGE</rwmon:statistic>
  <rwmon:operation>GE</rwmon:operation>
  <rwmon:value>0.0</rwmon:value>
  <rwmon:period>0</rwmon:period>
  <rwmon:evaluations>0</rwmon:evaluations>
</rwmon:alarm>

rwmon:actions

Key Identifiers:

XPath Path	/rw-project:project/rwmon:alarm/rwmon:actions
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwmon:alarm/rwmon:actions
RW.REST URI Path	/rw-project:project/STRING/rwmon:alarm/actions

Fields

Name	Type	Description
ok	LIST
insufficient-data	LIST
alarm	LIST

JSON Config Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwmon:actions xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:ok>
    <rwmon:url>STRING</rwmon:url>
  </rwmon:ok>
  <rwmon:insufficient-data>
    <rwmon:url>STRING</rwmon:url>
  </rwmon:insufficient-data>
  <rwmon:alarm>
    <rwmon:url>STRING</rwmon:url>
  </rwmon:alarm>
</rwmon:actions>

XML Sample

<rwmon:actions xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:ok>
    <rwmon:url>STRING</rwmon:url>
  </rwmon:ok>
  <rwmon:insufficient-data>
    <rwmon:url>STRING</rwmon:url>
  </rwmon:insufficient-data>
  <rwmon:alarm>
    <rwmon:url>STRING</rwmon:url>
  </rwmon:alarm>
</rwmon:actions>

rwmon:ok

Key Identifiers:

XPath Path

/rw-project:project/rwmon:alarm/rwmon:actions/rwmon:ok

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:alarm/rwmon:actions/rwmon:ok[rwmon:url='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwmon:alarm/actions/ok/STRING

Fields

Name	Type	Description
url	STRING

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<rwmon:ok xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:url>STRING</rwmon:url>
</rwmon:ok>

XML Sample

<rwmon:ok xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:url>STRING</rwmon:url>
</rwmon:ok>

rwmon:insufficient-data

Key Identifiers:

XPath Path

/rw-project:project/rwmon:alarm/rwmon:actions/rwmon:insufficient-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:alarm/rwmon:actions/rwmon:insufficient-data[rwmon:url='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwmon:alarm/actions/insufficient-data/STRING

Fields

Name	Type	Description
url	STRING

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<rwmon:insufficient-data xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:url>STRING</rwmon:url>
</rwmon:insufficient-data>

XML Sample

<rwmon:insufficient-data xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:url>STRING</rwmon:url>
</rwmon:insufficient-data>

rwmon:alarm

Key Identifiers:

XPath Path

/rw-project:project/rwmon:alarm/rwmon:actions/rwmon:alarm

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwmon:alarm/rwmon:actions/rwmon:alarm[rwmon:url='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwmon:alarm/actions/alarm/STRING

Fields

Name	Type	Description
url	STRING

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<rwmon:alarm xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:url>STRING</rwmon:url>
</rwmon:alarm>

XML Sample

<rwmon:alarm xmlns:rwmon="http://riftio.com/ns/riftware-1.0/rwmon">
  <rwmon:url>STRING</rwmon:url>
</rwmon:alarm>

rwmon - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Rwmon_Rwmon_t_schema
Global Schema Pointer	rw_ypbc_Rwmon_Rwmon_g_schema