User documentation for yang module vnffgd.yang

module rw-project                                                            1
  rw-project data                                                          1.1
    list rw-project:project                                              1.1.1
      container rw-project:project-config                              1.1.1.1
        list rw-project:user                                         1.1.1.1.1
          list rw-project:role                                     1.1.1.1.1.1
      container rw-project:project-state                               1.1.1.2
        list rw-project:user                                         1.1.1.2.1
          list rw-project:role                                     1.1.1.2.1.1
        list rw-project:role                                         1.1.1.2.2
      container vnffgd:vnffgd-catalog                                  1.1.1.3
        list vnffgd:vnffgd                                           1.1.1.3.1
module vnffgd                                                                2


1  module rw-project

1.1  rw-project data
  Description
    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.

1.1.1  list rw-project:project
  Description
    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.)
  Leaves
    name: name, type: STRING, description: Name of the project.
    name: description, type: STRING, description: Information about project
  XPath Path
    /rw-project:project
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']
  RW.REST URI Path
    /rw-project:project/STRING
  JSON Config Sample
    [
      {
        "name": "STRING",
        "description": "STRING",
        "project-config": {
          "user": [ { ... }, { ... } ]
        },
        "vnffgd:vnffgd-catalog": {
          "vnffgd": [ { ... }, { ... } ]
        }
      }, {
        ...
      }
    ]
  JSON Sample
    [
      {
        "name": "STRING",
        "description": "STRING",
        "project-config": {
          "user": [ { ... }, { ... } ]
        },
        "project-state": {
          "user": [ { ... }, { ... } ],
          "role": [ { ... }, { ... } ]
        },
        "vnffgd:vnffgd-catalog": {
          "vnffgd": [ { ... }, { ... } ]
        }
      }, {
        ...
      }
    ]
  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>
      <vnffgd:vnffgd-catalog xmlns:vnffgd="urn:ietf:params:xml:ns:yang:nfvo:vnffgd">
        <vnffgd:vnffgd>...</vnffgd:vnffgd>
      </vnffgd:vnffgd-catalog>
    </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>
      <vnffgd:vnffgd-catalog xmlns:vnffgd="urn:ietf:params:xml:ns:yang:nfvo:vnffgd">
        <vnffgd:vnffgd>...</vnffgd:vnffgd>
      </vnffgd:vnffgd-catalog>
    </rw-project:project>

1.1.1.1  container rw-project:project-config
  Description
    General Project configuration supported by all products.
  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
  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>

1.1.1.1.1  list rw-project:user
  Description
    The list of Users who have been assigned Roles within this
    Project.
  Leaves
    name: user-domain, type: LEAFREF, description: 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.
    name: user-name, type: LEAFREF, description: 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.
  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
  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>

1.1.1.1.1.1  list rw-project:role
  Description
    The list of Roles the User has been assigned.
  Leaves
    name: role, type: STRING, description: The Role, independent of Keys.
  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
  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>

1.1.1.2  container rw-project:project-state
  Description
    General Project operational state supported by all products.
  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
  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>

1.1.1.2.1  list rw-project:user
  Description
    The state of Users who have been assigned Roles within
    this Project.
  Leaves
    name: user-domain, type: STRING, description: 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.
    name: user-name, type: STRING, description: 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.
  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
  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>

1.1.1.2.1.1  list rw-project:role
  Description
    The state of the Roles the User has been assigned.
  Leaves
    name: role, type: STRING, description: The Role, independent of Keys.
    name: state, type: STRING, description: 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.
  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
  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>

1.1.1.2.2  list rw-project:role
  Description
    The set of Roles that may be configured into
    /rw-project:project/rw-project:config/rw-project:user/
    rw-project:role.
  Leaves
    name: role, type: STRING, description: The Role, independent of Keys.
    name: description, type: STRING, description: A description of the Role.
  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
  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>

1.1.1.3  container vnffgd:vnffgd-catalog
  XPath Path
    /rw-project:project/vnffgd:vnffgd-catalog
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vnffgd:vnffgd-catalog
  RW.REST URI Path
    /rw-project:project/STRING/vnffgd:vnffgd-catalog
  JSON Config Sample
    {
      "vnffgd": [
        {
          "name": "STRING",
          "id": "STRING",
          "provider": "STRING",
          "description": "STRING",
          "version": "STRING"
        }, {
          ...
        }
      ]
    }
  JSON Sample
    {
      "vnffgd": [
        {
          "name": "STRING",
          "id": "STRING",
          "provider": "STRING",
          "description": "STRING",
          "version": "STRING"
        }, {
          ...
        }
      ]
    }
  XML Config Sample
    <vnffgd:vnffgd-catalog xmlns:vnffgd="urn:ietf:params:xml:ns:yang:nfvo:vnffgd">
      <vnffgd:vnffgd>
        <vnffgd:id>STRING</vnffgd:id>
        <vnffgd:name>STRING</vnffgd:name>
        <vnffgd:provider>STRING</vnffgd:provider>
        <vnffgd:description>STRING</vnffgd:description>
        <vnffgd:version>STRING</vnffgd:version>
      </vnffgd:vnffgd>
    </vnffgd:vnffgd-catalog>
  XML Sample
    <vnffgd:vnffgd-catalog xmlns:vnffgd="urn:ietf:params:xml:ns:yang:nfvo:vnffgd">
      <vnffgd:vnffgd>
        <vnffgd:id>STRING</vnffgd:id>
        <vnffgd:name>STRING</vnffgd:name>
        <vnffgd:provider>STRING</vnffgd:provider>
        <vnffgd:description>STRING</vnffgd:description>
        <vnffgd:version>STRING</vnffgd:version>
      </vnffgd:vnffgd>
    </vnffgd:vnffgd-catalog>

1.1.1.3.1  list vnffgd:vnffgd
  Leaves
    name: name, type: STRING, description: VNF Forwarding Graph Descriptor name.
    name: id, type: STRING, description: Identifier for the VNFFGD.
    name: provider, type: STRING, description: Provider of the VNFFGD.
    name: description, type: STRING, description: Description of the VNFFGD.
    name: version, type: STRING, description: Version of the VNFFGD
  XPath Path
    /rw-project:project/vnffgd:vnffgd-catalog/vnffgd:vnffgd
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vnffgd:vnffgd-catalog/vnffgd:vnffgd[vnffgd:id='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/vnffgd:vnffgd-catalog/vnffgd/STRING
  JSON Config Sample
    [
      {
        "name": "STRING",
        "id": "STRING",
        "provider": "STRING",
        "description": "STRING",
        "version": "STRING"
      }, {
        ...
      }
    ]
  JSON Sample
    [
      {
        "name": "STRING",
        "id": "STRING",
        "provider": "STRING",
        "description": "STRING",
        "version": "STRING"
      }, {
        ...
      }
    ]
  XML Config Sample
    <vnffgd:vnffgd xmlns:vnffgd="urn:ietf:params:xml:ns:yang:nfvo:vnffgd">
      <vnffgd:id>STRING</vnffgd:id>
      <vnffgd:name>STRING</vnffgd:name>
      <vnffgd:provider>STRING</vnffgd:provider>
      <vnffgd:description>STRING</vnffgd:description>
      <vnffgd:version>STRING</vnffgd:version>
    </vnffgd:vnffgd>
  XML Sample
    <vnffgd:vnffgd xmlns:vnffgd="urn:ietf:params:xml:ns:yang:nfvo:vnffgd">
      <vnffgd:id>STRING</vnffgd:id>
      <vnffgd:name>STRING</vnffgd:name>
      <vnffgd:provider>STRING</vnffgd:provider>
      <vnffgd:description>STRING</vnffgd:description>
      <vnffgd:version>STRING</vnffgd:version>
    </vnffgd:vnffgd>

2  module vnffgd

