XOS TOSCA Reference

This documentation is autogenerated from the XOS Tosca custom_types specification (xos/tosca/custom_types/xos.m4). Table of Contents:


tosca.nodes.AccessAgent

Description:

CORD: A vOLT Access Agent.

Capabilities:

Properties:

namerequiredtypedefault
mac False string
mac address
replaces False string
port_mappings False string
list of port mappings, in format "port mac", multiple entries separated by commas
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.AddressPool

Description:

A pool of addresses

Capabilities:

nametype
addresspooltosca.capabilities.xos.AddressPool

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
gateway_ip False string
gateway ip address
addresses False string
space-separated list of addresses
gateway_mac False string
gateway mac address
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.CDNService

Description:

Content Delivery Network Service. Includes Request Routing and Hypercache.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.CORDSubscriber

Description:

CORD: Subscriber. The Subscriber object contains all of the settings for a CORD household. For example, it contains parental control filter settings.

Capabilities:

nametype
subscribertosca.capabilities.xos.Subscriber

Properties:

namerequiredtypedefault
kind string generic
Kind of subscriber
cdn_enable boolean True
If True, then the CDN is enabled.
url_filter_level string PG
The default URL filter level for the household.
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service
firewall_enable boolean False
If True, then firewalling is enabled.
url_filter_enable boolean False
If True, then parental controls are enabled.

tosca.nodes.CORDUser

Description:

CORD: User. The CORD user represents an individual device beloning to the CORD Subscriber. Each device may have its own parental controls.

Capabilities:

nametype
devicetosca.capabilities.xos.Device

Properties:

namerequiredtypedefault
mac True string
MAC address for this device.
level string PG_13
Parental control level for this device.

tosca.nodes.Compute.Container

Description:

The TOSCA Compute node represents a container on bare metal.

Capabilities:

nametype
bindingtosca.capabilities.network.Bindable
hosttosca.capabilities.Container
ostosca.capabilities.OperatingSystem
scalabletosca.capabilities.Scalable

Properties:


tosca.nodes.Controller

Description:

An XOS controller. Controllers serve as the interface between XOS and services such as OpenStack.

Capabilities:

nametype
controllertosca.capabilities.xos.Controller

Properties:

namerequiredtypedefault
domain False string
OpenStack domain (or "Default")
backend_type False string
Type of backend.
rabbit_host False string
Rabbit host
admin_user False string
Keystone username.
replaces False string
no-update boolean False
Do not allow Tosca to update this object
rabbit_password False string
Rabbit password
no-delete boolean False
Do not allow Tosca to delete this object
version False string
Version of backend.
auth_url False string
Keystone auth_url.
admin_password False string
Keystone password.
no-create boolean False
Do not allow Tosca to create this object
admin_tenant False string
Tenant associated with admin account.
rabbit_user False string
Rabbit user

tosca.nodes.DashboardView

Description:

An XOS Dashboard View

Capabilities:

nametype
dashboardviewtosca.capabilities.xos.DashboardView

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
custom_icon boolean False
Whether the dashboard has custom icons
url False string
URL to the dashboard
enabled boolean True
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Deployment

Description:

An XOS Deployment.

Capabilities:

nametype
deploymenttosca.capabilities.xos.Deployment

Properties:

namerequiredtypedefault
accessControl string allow all
ACL that describes who may use this deployment.
flavors False string
Comma-separated list of flavors that this deployment supports.
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.DeploymentRole

Description:

An XOS Deployment Role.

Capabilities:

nametype
deploymentroletosca.capabilities.xos.DeploymentRole

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.FabricService

Description:

CORD: The Fabric Service.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Flavor

Description:

An XOS Flavor.

Capabilities:

nametype
flavortosca.capabilities.xos.Flavor

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
flavor False string
openstack flavor name
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Image

Description:

An XOS Operating System Image.

Capabilities:

nametype
imagetosca.capabilities.xos.Image

Properties:

namerequiredtypedefault
kind False string
Type of image (container | VM)
replaces False string
disk_format False string
Glance disk format.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
tag False string
For Docker images, tag of image
container_format False string
Glance container format.
path False string
Path to Image file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Library

Description:

An XOS Library.

Capabilities:

Properties:

namerequiredtypedefault
private_key False string
private key
models False string
url of models.py
rest_service False string
url of REST API service file
no-delete boolean False
Do not allow Tosca to delete this object
django_library False string
libraries used by admin or models
tosca_custom_types False string
url of tosca custom_types
tosca_resource False string
url of tosca resource
public_key False string
public key
replaces False string
admin False string
url of admin.py
no-update boolean False
Do not allow Tosca to update this object
base_url False string
Base url, to allow resources to use relative URLs
rest_tenant False string
url of REST API tenant file
version False string
Version number of this Service Controller
provides False string
Comma-separated list of things provided
admin_template False string
url of admin html template
no-create boolean False
Do not allow Tosca to create this object
requires False string
Comma-separated list of requirements

tosca.nodes.NetworkParameterType

Description:

An XOS network parameter type. May be applied to Networks and/or Ports.

Capabilities:

nametype
network_parameter_typetosca.capabilities.xos.NetworkParameterType

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.NetworkTemplate

Description:

An XOS network template. Network templates contain settings associated with a particular class of network.

Capabilities:

nametype
network_templatetosca.capabilities.xos.NetworkTemplate

Properties:

namerequiredtypedefault
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
visibility False string
Indicates whether network is publicly routable.
shared_network_id False string
Attaches this template to a specific OpenStack network.
access False string
The type of access semantics for this network
shared_network_name False string
Attaches this template to a specific OpenStack network.
vtn_kind False string
Network kind to pass to VTN
translation False string
Indicates whether network uses address translation.
topology_kind False string
Describes the topology of the network.
controller_kind False string
Indicates the type of controller that the network is connected to.
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Node

Description:

An XOS Node. Nodes are physical machines that host virtual machines and/or containers.

Capabilities:

nametype
nodetosca.capabilities.xos.Node

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.NodeLabel

Description:

An XOS NodeLabel.

Capabilities:

nametype
nodetosca.capabilities.xos.NodeLabel

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.ONOSApp

Description:

An ONOS Application.

Capabilities:

Properties:

namerequiredtypedefault
kind string generic
Kind of tenant
dependencies False string
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service

tosca.nodes.ONOSService

Description:

ONOS Service

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
node_key False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
rest_port False string
versionNumber False string
Version number of Service.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object
rest_onos/v1/network/configuration/ False string
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
rest_hostname False string
icon_url False string
ICON to display in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
no_container boolean False
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True

tosca.nodes.ONOSVTNApp

Description:

An ONOS VTN Application.

Capabilities:

Properties:

namerequiredtypedefault
rest_onos/v1/network/configuration/ False string
kind string generic
Kind of tenant
dependencies False string
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service
autogenerate False string
install_dependencies False string

tosca.nodes.ONOSvBNGApp

Description:

An ONOS vBNG Application.

Capabilities:

Properties:

namerequiredtypedefault
config_virtualbng.json False string
kind string generic
Kind of tenant
config_network-cfg.json False string
config_addresses.json False string
install_dependencies False string
dependencies False string
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service
component_config False string

tosca.nodes.ONOSvOLTApp

Description:

An ONOS vOLT Application.

Capabilities:

Properties:

namerequiredtypedefault
rest_onos/v1/network/configuration/ False string
kind string generic
Kind of tenant
config_network-cfg.json False string
autogenerate False string
install_dependencies False string
dependencies False string
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service
component_config False string

tosca.nodes.ONOSvRouterApp

Description:

An ONOS vRouter Application.

Capabilities:

Properties:

namerequiredtypedefault
rest_onos/v1/network/configuration/ False string
kind string generic
Kind of tenant
dependencies False string
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service
autogenerate False string
install_dependencies False string

tosca.nodes.Service

Description:

An XOS Service object. Services may be listed in the Service directory and may be linked together via Tenancy Relationships.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.ServiceController

Description:

An XOS Service Controller.

Capabilities:

Properties:

namerequiredtypedefault
private_key False string
private key
models False string
url of models.py
rest_service False string
url of REST API service file
synchronizer False string
url of synchronizer manifest
tosca_custom_types False string
url of tosca custom_types
synchronizer_config False string
synchronizer config filename
django_library False string
libraries used by admin or models
no-delete boolean False
Do not allow Tosca to delete this object
synchronizer_run False string
synchronizer run command
tosca_resource False string
url of tosca resource
public_key False string
public key
replaces False string
admin False string
url of admin.py
no-update boolean False
Do not allow Tosca to update this object
base_url False string
Base url, to allow resources to use relative URLs
rest_tenant False string
url of REST API tenant file
version False string
Version number of this Service Controller
provides False string
Comma-separated list of things provided
admin_template False string
url of admin html template
no-create boolean False
Do not allow Tosca to create this object
requires False string
Comma-separated list of requirements

tosca.nodes.ServiceControllerResource

Description:

An XOS Service Resource.

Capabilities:

Properties:

namerequiredtypedefault
kind False string
models, admin, django_library, synchronizer, rest, tosca_custom_types, or tosca_resource
replaces False string
format False string
python, manifest, or docker
url False string
url of resource, may be relative to base_url or absolute
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Site

Description:

An XOS Site. Sites are containers for Users and/or Nodes.

Capabilities:

nametype
sitetosca.capabilities.xos.Site

Properties:

namerequiredtypedefault
replaces False string
display_name False string
Name of the site.
no-update boolean False
Do not allow Tosca to update this object
enabled boolean True
site_url False string
URL of site web page.
no-delete boolean False
Do not allow Tosca to delete this object
hosts_nodes boolean True
If True, then this site hosts nodes where Instances may be instantiated.
is_public boolean True
hosts_users boolean True
If True, then this site hosts users who may use XOS.
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.SiteRole

Description:

An XOS Site Role.

Capabilities:

nametype
siteroletosca.capabilities.xos.SiteRole

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Slice

Description:

An XOS Slice. A slice is a collection of instances that share common attributes.

Capabilities:

nametype
slicetosca.capabilities.xos.Slice

Properties:

namerequiredtypedefault
exposed_ports False string
comma-separated list of protocol _space_ port that represent ports the slice should expose
replaces False string
description False string
Description of this slice.
default_isolation False string
default isolation to use when bringing up instances (default to 'vm')
enabled boolean True
no-update boolean False
Do not allow Tosca to update this object
max_instances integer 10
Quota of instances that this slice may create.
no-delete boolean False
Do not allow Tosca to delete this object
slice_url False string
URL to web page that describes slice.
default_node False string
default node to use for this slice
no-create boolean False
Do not allow Tosca to create this object
network False string
type of networking to use for this slice

tosca.nodes.SliceRole

Description:

An XOS Slice Role.

Capabilities:

nametype
sliceroletosca.capabilities.xos.SliceRole

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Subscriber

Description:

XOS subscriber base class.

Capabilities:

nametype
subscribertosca.capabilities.xos.Subscriber

Properties:

namerequiredtypedefault
kind string generic
Kind of subscriber
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service

tosca.nodes.Tag

Description:

An XOS Tag

Capabilities:

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
name True string
no-update boolean False
Do not allow Tosca to update this object
value False string
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.Tenant

Description:

An ONOS Tenant.

Capabilities:

Properties:

namerequiredtypedefault
kind string generic
Kind of tenant
service_specific_attribute False string
Service-specific attribute, usually a string containing a json dictionary
model False string
Name of model to use when instantiating tenant
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service

tosca.nodes.TenantRole

Description:

An XOS Tenant Role.

Capabilities:

nametype
tenantroletosca.capabilities.xos.TenantRole

Properties:

namerequiredtypedefault
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.User

Description:

An XOS User record. Users are able to login and use the XOS GUI.

Capabilities:

nametype
usertosca.capabilities.xos.User

Properties:

namerequiredtypedefault
public_key False string
Public key that will be installed in Instances.
replaces False string
no-create boolean False
Do not allow Tosca to create this object
firstname False string
First name of User.
is_readonly False boolean
If True, the user has read-only privileges in the UI.
user_url False string
URL to User web page.
lastname False string
Last name of User.
no-update boolean False
Do not allow Tosca to update this object
is_appuser False boolean
If True, the user may only login to XOS to use apps.
is_active False boolean
If True, the user may log in.
phone False string
Phone number of User.
no-delete boolean False
Do not allow Tosca to delete this object
is_admin False boolean
If True, the user has root admin privileges.
password False string
login_page False string
Indicates what page the user should go to on login.

tosca.nodes.VBNGService

Description:

CORD: The vBNG Service.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
vbng_url False string
URL of REST API endpoint for vBNG Service.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.VOLTDevice

Description:

CORD: A vOLT Device.

Capabilities:

Properties:

namerequiredtypedefault
access_devices False string
list of access devices, in format "uplink vlan", multiple entries separated by commas
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
openflow_id False string
openflow id
driver False string
driver name
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.VOLTService

Description:

CORD: The vOLT Service

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.VOLTTenant

Description:

CORD: A Tenant of the vOLT Service. Each Tenant is tied to a specific vlan_id.

Capabilities:

Properties:

namerequiredtypedefault
kind string generic
Kind of tenant
c_tag False string
c_tag, identifies which subscriber within s_tag
s_tag False string
s_tag, identifies which volt port
service_specific_id False string
Service specific ID opaque to XOS but meaningful to service

tosca.nodes.VRouterService

Description:

CORD: The vRouter Service.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
published boolean True
If True then display this Service in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.VSGService

Description:

CORD: The vSG Service.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
node_label False string
backend_network_label False string
Label that matches network used to connect HPC and BBS services.
published boolean True
If True then display this Service in the Service Directory.
no-update boolean False
Do not allow Tosca to update this object
no-delete boolean False
Do not allow Tosca to delete this object
versionNumber False string
Version number of Service.
dns_servers False string
view_url False string
URL to follow when icon is clicked in the Service Directory.
enabled boolean True
icon_url False string
ICON to display in the Service Directory.
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.VTNService

Description:

CORD: The vRouter Service.

Capabilities:

nametype
scalabletosca.capabilities.Scalable
servicetosca.capabilities.xos.Service

Properties:

namerequiredtypedefault
view_url False string
URL to follow when icon is clicked in the Service Directory.
mgmtSubnetBits False string
sshKeyFile False string
xosUser False string
versionNumber False string
Version number of Service.
sshPort False string
private_key_fn False string
Location of private key file
no-create boolean False
Do not allow Tosca to create this object
sshUser False string
public_key False string
Public key to install into Instances to allows Services to SSH into them.
kind string generic
Type of service.
replaces False string
no-delete boolean False
Do not allow Tosca to delete this object
xosEndpoint False string
icon_url False string
ICON to display in the Service Directory.
enabled boolean True
vtnAPIVersion False string
xosPassword False string
ovsdbPort False string
no-update boolean False
Do not allow Tosca to update this object
published boolean True
If True then display this Service in the Service Directory.
localManagementIp False string
privateGatewayMac False string

tosca.nodes.XOS

Description:

The root of XOS

Capabilities:

Properties:

namerequiredtypedefault
replaces False string
frontend_only False boolean
True if XOS should not start synchronizer containers
db_container_name False string
Database container name
ui_port False integer
TCP port of user interface
no-update boolean False
Do not allow Tosca to update this object
enable_build False boolean
True if XOS build should be enabled
source_ui_image False string
Source UI docker image name
no-delete boolean False
Do not allow Tosca to delete this object
docker_project_name False string
Docker project name
extra_hosts False string
List of extra_hosts to pass to docker compose
bootstrap_ui_port False integer
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.XOSVolume

Description:

A volume that should be attached to the XOS docker container

Capabilities:

Properties:

namerequiredtypedefault
read_only False boolean
True if mount read only
no-delete boolean False
Do not allow Tosca to delete this object
replaces False string
host_path False string
path of resource on host
no-update boolean False
Do not allow Tosca to update this object
no-create boolean False
Do not allow Tosca to create this object

tosca.nodes.network.Network.XOS

Description:

This is a variant of the TOSCA Network object that includes additional XOS-specific properties.

Capabilities:

nametype
linktosca.capabilities.network.Linkable

Properties:

namerequiredtypedefault
permit_all_slices boolean True
If True, then any slice may be attached to this network.
segmentation_id False string
A segmentation identifier in the underlying cloud infrastructure. E.g. VLAN ID, GRE tunnel ID, etc..
labels False string
A comma-separated list of labels for this network.
no-delete boolean False
Do not allow Tosca to delete this object
start_ip False string
The IP address to be used as the start of a pool of addresses within the full IP range derived from the cidr block.
cidr False string
The cidr block of the requested network.
network_name False string
An identifier that represents an existing Network instance in the underlying cloud infrastructure or can be used as the name of the newly created network. If network_name is provided and no other properties are provided (with exception of network_id), then an existing network instance will be used. If network_name is provided alongside with more properties then a new network with this name will be created.
no-create boolean False
Do not allow Tosca to create this object
replaces False string
network_id False string
An identifier that represents an existing Network instance in the underlying cloud infrastructure. This property is mutually exclusive with all other properties except network_name. This can be used alone or together with network_name to identify an existing network.
no-update boolean False
Do not allow Tosca to update this object
dhcp_enabled False boolean True
Indicates should DHCP service be enabled on the network or not.
end_ip False string
The IP address to be used as the end of a pool of addresses within the full IP range derived from the cidr block.
gateway_ip False string
The gateway IP address.
ip_version False integer 4
The IP version of the requested network. Valid values are 4 for ipv4 or 6 for ipv6.
ports False string
A comma-separated list of protocols and ports. For example, "tcp/123, tcp/456-459, udp/111"

XOS Relationships

nametarget_types
tosca.relationships SiteDeploymenttosca.capabilities.xos.Deployment
tosca.relationships.AccessPrivilegetosca.capabilities.xos.Slice, tosca.capabilities.xos.Site
tosca.relationships.AdminPrivilegetosca.capabilities.xos.Slice, tosca.capabilities.xos.Site
tosca.relationships.BelongsToSubscribertosca.capabilities.xos.Subscriber
tosca.relationships.ConnectsToNetworktosca.capabilities.xos.Network
tosca.relationships.ConnectsToSlicetosca.capabilities.xos.Slice
tosca.relationships.ControllerDeploymenttosca.capabilities.xos.Deployment
tosca.relationships.DefaultFlavortosca.capabilities.xos.Flavor
tosca.relationships.DefaultImagetosca.capabilities.xos.Image
tosca.relationships.DependsOn
tosca.relationships.HasLabeltosca.capabilities.xos.NodeLabel
tosca.relationships.HasResource
tosca.relationships.MemberOfDeploymenttosca.capabilities.xos.Deployment
tosca.relationships.MemberOfDevice
tosca.relationships.MemberOfServicetosca.capabilities.xos.Service
tosca.relationships.MemberOfSitetosca.capabilities.xos.Site
tosca.relationships.MemberOfSlicetosca.capabilities.xos.Slice
tosca.relationships.PIPrivilegetosca.capabilities.xos.Site
tosca.relationships.ProvidesAddressestosca.capabilities.xos.AddressPool
tosca.relationships.SubscriberDevicetosca.capabilities.xos.Subscriber
tosca.relationships.SupportsFlavortosca.capabilities.xos.Flavor
tosca.relationships.SupportsImagetosca.capabilities.xos.Image
tosca.relationships.TagsObject
tosca.relationships.TechPrivilegetosca.capabilities.xos.Site
tosca.relationships.TenantOfServicetosca.capabilities.xos.Service
tosca.relationships.UsedByController
tosca.relationships.UsedByServicetosca.capabilities.xos.Service
tosca.relationships.UsedByXOS
tosca.relationships.UsesAgent
tosca.relationships.UsesControllertosca.capabilities.xos.Controller
tosca.relationships.UsesDashboardtosca.capabilities.xos.DashboardView
tosca.relationships.UsesImagetosca.capabilities.xos.Image
tosca.relationships.UsesNetworkTemplatetosca.capabilities.xos.NetworkTemplate

XOS Capabilities

name
tosca.capabilities.xos.AddressPool
tosca.capabilities.xos.Controller
tosca.capabilities.xos.DashboardView
tosca.capabilities.xos.Deployment
tosca.capabilities.xos.DeploymentRole
tosca.capabilities.xos.Device
tosca.capabilities.xos.Flavor
tosca.capabilities.xos.Image
tosca.capabilities.xos.NetworkParameterType
tosca.capabilities.xos.NetworkTemplate
tosca.capabilities.xos.Node
tosca.capabilities.xos.NodeLabel
tosca.capabilities.xos.Service
tosca.capabilities.xos.Site
tosca.capabilities.xos.SiteRole
tosca.capabilities.xos.Slice
tosca.capabilities.xos.SliceRole
tosca.capabilities.xos.Subscriber
tosca.capabilities.xos.TenantRole
tosca.capabilities.xos.User