Contrail Configuration API Specification

Configuration objects in Contrail are created either by

• User (via GUI, api or an external program) for abstractions visible to End Users.
• System (contrail processes like contrail-schema, contrail-svc-monitor etc.) to aid in functioning of all the control components/services.

So for e.g. an end-user might create a virtual-network, but the system creates a routing-instance and route-target for that virtual-network.

User created object types

service-endpoint instance-ip service-appliance-set dsa-rule discovery-service-assignment floating-ip-pool physical-router config-root service-template hardware-inventory firewall-policy route-table provider-attachment overlay-role config-properties network-device-config virtual-DNS-record control-node-zone route-target structured-syslog-config loadbalancer-listener logical-interface flow-node port-group route-aggregate logical-router domain structured-syslog-hostname-record routing-policy node-profile bridge-domain alias-ip network-policy port bgp-as-a-service subnet global-system-config sub-cluster forwarding-class service-group global-analytics-config

address-group application-policy-set virtual-ip intent-map analytics-alarm-node netconf-profile qos-queue physical-role card global-qos-config qos-config analytics-snmp-node virtual-machine-interface cli-config service-object feature-flag loadbalancer structured-syslog-tenant-record peering-policy structured-syslog-application-record global-vrouter-config webui-node floating-ip link-aggregation-group virtual-router port-profile policy-management e2-service-provider fabric job-template service-instance role-config tag-type structured-syslog-message loadbalancer-pool security-logging-object analytics-node virtual-DNS config-database-node config-node device-functional-group

firewall-rule bgpvpn role-definition service-connection-module security-group database-node loadbalancer-healthmonitor devicemgr-node project fabric-namespace alarm multicast-policy device-chassis sflow-profile hardware tag feature-config telemetry-profile bgp-router virtual-network virtual-port-group loadbalancer-member namespace feature storm-control-profile device-image physical-interface snmp-profile node grpc-profile customer-attachment structured-syslog-sla-profile host-based-service virtual-machine interface-route-table service-appliance service-health-check network-ipam api-access-list alias-ip-pool data-center-interconnect

System created object types

routing-instance

access-control-list

port-tuple

Type specific REST API and data model

access-control-list

Data Model

Description

When parent is virtual-network,

Virtual network access control list are automatically derived from all the network policies attached to virtual network.

When parent is security-group,

port access control list is automatically derived from all the security groups attached to port.

Parents: virtual-network, security-group

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
access-control-list-entries	Automatically generated by system based on security groups or network policies.	False	AclEntriesType	CRUD	system
access-control-list-hash	A hash value of all the access-control-list-entries in this ACL objects automatically generated by system.	False	unsignedLong	CRUD	system

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific access-control-list

GET /access-control-list/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AccessControlListReadAll
404	Not Found	Error

Update a specific access-control-list

PUT /access-control-list/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	access-control-list optional		AccessControlListUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific access-control-list

DELETE /access-control-list/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of access-control-list

GET /access-control-lists

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new access-control-list

POST /access-control-lists

Parameters

Type	Name	Description	Schema	Default
body	access-control-list required	Body of access-control-list resource	AccessControlListCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

address-group

Data Model

Description

When parent is policy-management,

Address Group object

When parent is project,

Project level address Group object

Parents: policy-management, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
draft-mode-state	None	False	string	R	user
address-group-prefix	List of IP prefix	False	SubnetListType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:firewall-rule firewall-rule-label

REST API

Fetch a specific address-group

GET /address-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AddressGroupReadAll
404	Not Found	Error

Update a specific address-group

PUT /address-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	address-group optional		AddressGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific address-group

DELETE /address-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of address-group

GET /address-groups

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new address-group

POST /address-groups

Parameters

Type	Name	Description	Schema	Default
body	address-group required	Body of address-group resource	AddressGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

alarm

Data Model

Description

When parent is global-system-config,

List of alarms that are applicable to objects anchored under global-system-config.

When parent is project,

List of alarms that are applicable to objects anchored under the project.

Parents: global-system-config, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
uve-keys	List of UVE tables or UVE objects where this alarm config should be applied. For example, rules based on NodeStatus UVE can be applied to multiple object types or specific uve objects such as analytics-node, config-node, control-node:<hostname>, etc.,	True	UveKeysType	CRUD	user
alarm-severity	Severity level for the alarm.	True	number	CRUD	user
alarm-rules	Rules based on the UVE attributes specified as OR-of-ANDs of AlarmExpression template. Example: ‘alarm_rules’: {‘or_list’: [{‘and_list’: [{AlarmExpression1}, {AlarmExpression2}, ...]}, {‘and_list’: [{AlarmExpression3}, {AlarmExpression4}, ...]}]}	False	AlarmOrList	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific alarm

GET /alarm/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AlarmReadAll
404	Not Found	Error

Update a specific alarm

PUT /alarm/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	alarm optional		AlarmUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific alarm

DELETE /alarm/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of alarm

GET /alarms

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new alarm

POST /alarms

Parameters

Type	Name	Description	Schema	Default
body	alarm required	Body of alarm resource	AlarmCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific analytics-alarm-node

GET /analytics-alarm-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AnalyticsAlarmNodeReadAll
404	Not Found	Error

Update a specific analytics-alarm-node

PUT /analytics-alarm-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	analytics-alarm-node optional		AnalyticsAlarmNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific analytics-alarm-node

DELETE /analytics-alarm-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of analytics-alarm-node

GET /analytics-alarm-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new analytics-alarm-node

POST /analytics-alarm-nodes

Parameters

Type	Name	Description	Schema	Default
body	analytics-alarm-node required	Body of analytics-alarm-node resource	AnalyticsAlarmNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

alias-ip

Data Model

Description

alias ip is a ip that can be assigned to virtual-machine-interface(VMI), By doing so VMI can now be part of the alias ip network. packets originating with alias-ip as the source-ip belongs to alias- ip-network

Parents: alias-ip-pool

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
alias-ip-address	Alias ip address.	True	string	CR	user
alias-ip-address-family	Ip address family of the alias ip, IpV4 or IpV6	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:project project-label	Reference to project from which this alias ip was allocated.	True	None	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to virtual machine interface to which this alias ip is attached.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific alias-ip

GET /alias-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AliasIpReadAll
404	Not Found	Error

Update a specific alias-ip

PUT /alias-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	alias-ip optional		AliasIpUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific alias-ip

DELETE /alias-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of alias-ip

GET /alias-ips

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new alias-ip

POST /alias-ips

Parameters

Type	Name	Description	Schema	Default
body	alias-ip required	Body of alias-ip resource	AliasIpCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific alias-ip-pool

GET /alias-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AliasIpPoolReadAll
404	Not Found	Error

Update a specific alias-ip-pool

PUT /alias-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	alias-ip-pool optional		AliasIpPoolUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific alias-ip-pool

DELETE /alias-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of alias-ip-pool

GET /alias-ip-pools

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new alias-ip-pool

POST /alias-ip-pools

Parameters

Type	Name	Description	Schema	Default
body	alias-ip-pool required	Body of alias-ip-pool resource	AliasIpPoolCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

alias-ip-pool

Data Model

Description

Alias ip pool is set of addresses that are carved out of a given network. Ip(s) from this set can be assigned to virtual-machine-interface so that they become members of this network

Parents: virtual-network

Children

alias-ip

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:project project-label

REST API

Fetch a specific alias-ip-pool

GET /alias-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AliasIpPoolReadAll
404	Not Found	Error

Update a specific alias-ip-pool

PUT /alias-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	alias-ip-pool optional		AliasIpPoolUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific alias-ip-pool

DELETE /alias-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of alias-ip-pool

GET /alias-ip-pools

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new alias-ip-pool

POST /alias-ip-pools

Parameters

Type	Name	Description	Schema	Default
body	alias-ip-pool required	Body of alias-ip-pool resource	AliasIpPoolCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

analytics-alarm-node

Data Model

Description

Analytics node is object representing a logical node in system which serves operational API and analytics collector.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
analytics-alarm-node-ip-address	Ip address of the analytics alarm node, set while provisioning.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific analytics-alarm-node

GET /analytics-alarm-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AnalyticsAlarmNodeReadAll
404	Not Found	Error

Update a specific analytics-alarm-node

PUT /analytics-alarm-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	analytics-alarm-node optional		AnalyticsAlarmNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific analytics-alarm-node

DELETE /analytics-alarm-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of analytics-alarm-node

GET /analytics-alarm-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new analytics-alarm-node

POST /analytics-alarm-nodes

Parameters

Type	Name	Description	Schema	Default
body	analytics-alarm-node required	Body of analytics-alarm-node resource	AnalyticsAlarmNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

analytics-node

Data Model

Description

Analytics node is object representing a logical node in system which serves operational API and analytics collector.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
analytics-node-ip-address	Ip address of the analytics node, set while provisioning.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific analytics-node

GET /analytics-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AnalyticsNodeReadAll
404	Not Found	Error

Update a specific analytics-node

PUT /analytics-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	analytics-node optional		AnalyticsNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific analytics-node

DELETE /analytics-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of analytics-node

GET /analytics-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new analytics-node

POST /analytics-nodes

Parameters

Type	Name	Description	Schema	Default
body	analytics-node required	Body of analytics-node resource	AnalyticsNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

analytics-snmp-node

Data Model

Description

Analytics node is object representing a logical node in system which serves operational API and analytics collector.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
analytics-snmp-node-ip-address	Ip address of the analytics snmp node, set while provisioning.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific analytics-snmp-node

GET /analytics-snmp-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	AnalyticsSnmpNodeReadAll
404	Not Found	Error

Update a specific analytics-snmp-node

PUT /analytics-snmp-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	analytics-snmp-node optional		AnalyticsSnmpNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific analytics-snmp-node

DELETE /analytics-snmp-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of analytics-snmp-node

GET /analytics-snmp-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new analytics-snmp-node

POST /analytics-snmp-nodes

Parameters

Type	Name	Description	Schema	Default
body	analytics-snmp-node required	Body of analytics-snmp-node resource	AnalyticsSnmpNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

api-access-list

Data Model

Description

When parent is domain,

API access list is list of rules that define role based access to each API and its properties at domain level.

When parent is project,

API access list is list of rules that define role based access to each API and its properties at project level.

When parent is global-system-config,

Global API access list applicable to all domain and projects

Parents: domain, project, global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
api-access-list-entries	List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).	True	RbacRuleEntriesType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific api-access-list

GET /api-access-list/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ApiAccessListReadAll
404	Not Found	Error

Update a specific api-access-list

PUT /api-access-list/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	api-access-list optional		ApiAccessListUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific api-access-list

DELETE /api-access-list/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of api-access-list

GET /api-access-lists

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new api-access-list

POST /api-access-lists

Parameters

Type	Name	Description	Schema	Default
body	api-access-list required	Body of api-access-list resource	ApiAccessListCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

application-policy-set

Data Model

Description

When parent is policy-management,

Application-policy object defining policies to apply for a given application tag

When parent is project,

Project level application-policy object defining policies to apply for a given application tag

Parents: policy-management, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
draft-mode-state	None	False	string	R	user
all-applications	If set, indicates application policy set to be applied to all application tags	False	boolean	R	user

References

To	Description	Required	Type	Operations	Created By
:ref:firewall-policy firewall-policy-label	Reference to firewall-policy attached to this application-policy	True	FirewallSequence	CRUD	user
:ref:global-vrouter-config global-vrouter-config-label	Reference to global-vrouter-config is automatically created by system for global application policy sets	False	None	CRUD	system
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:project project-label

REST API

Fetch a specific application-policy-set

GET /application-policy-set/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ApplicationPolicySetReadAll
404	Not Found	Error

Update a specific application-policy-set

PUT /application-policy-set/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	application-policy-set optional		ApplicationPolicySetUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific application-policy-set

DELETE /application-policy-set/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of application-policy-set

GET /application-policy-sets

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new application-policy-set

POST /application-policy-sets

Parameters

Type	Name	Description	Schema	Default
body	application-policy-set required	Body of application-policy-set resource	ApplicationPolicySetCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

bgp-as-a-service

Data Model

Description

BGP as service object represents BGP peer in the virtual network that can participate in dynamic routing with implicit default gateway of the virtual network.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
autonomous-system	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	True	number	CRUD	user
bgpaas-shared	True if only one BGP router needs to be created. Otherwise, one BGP router is created for each VMI	False	boolean	CRUD	user
bgpaas-ip-address	Ip address of the BGP peer.	True	string	CRUD	user
bgpaas-session-attributes	BGP peering session attributes.	True	BgpSessionAttributes	CRUD	user
bgpaas-ipv4-mapped-ipv6-nexthop	True when client bgp implementation expects to receive a ipv4-mapped ipv6 address (as opposed to regular ipv6 address) as the bgp nexthop for ipv6 routes.	False	boolean	CRUD	user
bgpaas-suppress-route-advertisement	True when server should not advertise any routes to the client i.e. the client has static routes (typically a default) configured.	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:control-node-zone control-node-zone-label	Reference to control-node-zone for bgp-peer selection	False	BGPaaSControlNodeZoneAttributes	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to VMI on which BGPaaS BGP peering will happen.	True	None	CRUD	user
:ref:service-health-check service-health-check-label	Reference to health check object attached to BGPaaS object, used to enable BFD health check over active BGPaaS VMI.	False	None	CRUD	user
:ref:bgp-router bgp-router-label	Reference to internal BGP peer object automatically generated by the system.	False	None	CRUD	system
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific bgp-as-a-service

GET /bgp-as-a-service/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	BgpAsAServiceReadAll
404	Not Found	Error

Update a specific bgp-as-a-service

PUT /bgp-as-a-service/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	bgp-as-a-service optional		BgpAsAServiceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific bgp-as-a-service

DELETE /bgp-as-a-service/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of bgp-as-a-service

GET /bgp-as-a-services

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new bgp-as-a-service

POST /bgp-as-a-services

Parameters

Type	Name	Description	Schema	Default
body	bgp-as-a-service required	Body of bgp-as-a-service resource	BgpAsAServiceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

bgp-router

Data Model

Description

Parents: routing-instance

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
bgp-router-parameters	BGP router configuration parameters like ip address, AS number, hold time etc.	True	BgpRouterParams	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:control-node-zone control-node-zone-label	This bgp-router belongs to the referenced control-node-zone.	False	None	CRUD	user
:ref:sub-cluster sub-cluster-label	Reference of bgp-router to sub-cluster .	False	None	CRUD	user
:ref:bgp-router bgp-router-label	References to peer BGP router, property of the reference has BGP peering attributes.	False	BgpPeeringAttributes	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:bgp-as-a-service bgp-as-a-service-label, :ref:physical-router physical-router-label, :ref:virtual-machine-interface virtual-machine-interface-label, :ref:global-system-config global-system-config-label

REST API

Fetch a specific bgp-router

GET /bgp-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	BgpRouterReadAll
404	Not Found	Error

Update a specific bgp-router

PUT /bgp-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	bgp-router optional		BgpRouterUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific bgp-router

DELETE /bgp-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of bgp-router

GET /bgp-routers

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new bgp-router

POST /bgp-routers

Parameters

Type	Name	Description	Schema	Default
body	bgp-router required	Body of bgp-router resource	BgpRouterCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

bgpvpn

Data Model

Description

BGP VPN resource contains a set of parameters for a BGP-based VPN

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
route-target-list	List of route targets that are used as both import and export for this virtual network.	False	RouteTargetList	CRUD	user
import-route-target-list	List of route targets that are used as import for this virtual network.	False	RouteTargetList	CRUD	user
export-route-target-list	List of route targets that are used as export for this virtual network.	False	RouteTargetList	CRUD	user
bgpvpn-type	BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3).	True	string	CR	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:virtual-network virtual-network-label, :ref:logical-router logical-router-label

REST API

Fetch a specific bgpvpn

GET /bgpvpn/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	BgpvpnReadAll
404	Not Found	Error

Update a specific bgpvpn

PUT /bgpvpn/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	bgpvpn optional		BgpvpnUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific bgpvpn

DELETE /bgpvpn/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of bgpvpn

GET /bgpvpns

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new bgpvpn

POST /bgpvpns

Parameters

Type	Name	Description	Schema	Default
body	bgpvpn required	Body of bgpvpn resource	BgpvpnCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

bridge-domain

Data Model

Description

bridge-domains configured in a virtual network

Parents: virtual-network

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
mac-learning-enabled	Enable MAC learning on the network	False	boolean	CRUD	user
mac-limit-control	MAC limit control on the network	False	MACLimitControlType	CRUD	user
mac-move-control	MAC move control on the network	False	MACMoveLimitControlType	CRUD	user
mac-aging-time	MAC aging time on the network	False	number	CRUD	user
isid	i-sid value	True	number	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:virtual-machine-interface virtual-machine-interface-label

REST API

Fetch a specific bridge-domain

GET /bridge-domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	BridgeDomainReadAll
404	Not Found	Error

Update a specific bridge-domain

PUT /bridge-domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	bridge-domain optional		BridgeDomainUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific bridge-domain

DELETE /bridge-domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of bridge-domain

GET /bridge-domains

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new bridge-domain

POST /bridge-domains

Parameters

Type	Name	Description	Schema	Default
body	bridge-domain required	Body of bridge-domain resource	BridgeDomainCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

card

Data Model

Description

This resource contains the information about the interface card in a hardware platform.

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
interface-map	Interface map of all the physical ports on a physical interface card.	True	InterfaceMapType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:hardware hardware-label

REST API

Fetch a specific card

GET /card/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	CardReadAll
404	Not Found	Error

Update a specific card

PUT /card/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	card optional		CardUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific card

DELETE /card/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of card

GET /cards

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new card

POST /cards

Parameters

Type	Name	Description	Schema	Default
body	card required	Body of card resource	CardCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

cli-config

Data Model

Description

CLI commits done on a physical router.

Parents: physical-router

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
accepted-cli-config	Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with Contrail configuration	False	string	CRUD	user
commit-diff-list	CLI diff object containing details about the commit such as username, time and the configuration diff	False	CliDiffListType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific cli-config

GET /cli-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	CliConfigReadAll
404	Not Found	Error

Update a specific cli-config

PUT /cli-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	cli-config optional		CliConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific cli-config

DELETE /cli-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of cli-config

GET /cli-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new cli-config

POST /cli-configs

Parameters

Type	Name	Description	Schema	Default
body	cli-config required	Body of cli-config resource	CliConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

config-database-node

Data Model

Description

Config Database node is object representing a logical node in system which hosts Cassandra DB and Zookeeper for Config.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
config-database-node-ip-address	Ip address of the Config DB node, set while provisioning.	True	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific config-database-node

GET /config-database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ConfigDatabaseNodeReadAll
404	Not Found	Error

Update a specific config-database-node

PUT /config-database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	config-database-node optional		ConfigDatabaseNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific config-database-node

DELETE /config-database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of config-database-node

GET /config-database-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new config-database-node

POST /config-database-nodes

Parameters

Type	Name	Description	Schema	Default
body	config-database-node required	Body of config-database-node resource	ConfigDatabaseNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

config-node

Data Model

Description

Config node is object representing a logical node in system which serves config API.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
config-node-ip-address	Ip address of the config node, set while provisioning.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific config-node

GET /config-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ConfigNodeReadAll
404	Not Found	Error

Update a specific config-node

PUT /config-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	config-node optional		ConfigNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific config-node

DELETE /config-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of config-node

GET /config-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new config-node

POST /config-nodes

Parameters

Type	Name	Description	Schema	Default
body	config-node required	Body of config-node resource	ConfigNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

config-properties

Data Model

Description

List of config properties.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
properties	List of Config properties	False	KeyValuePairs	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific config-properties

GET /config-properties/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ConfigPropertiesReadAll
404	Not Found	Error

Update a specific config-properties

PUT /config-properties/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	config-properties optional		ConfigPropertiesUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific config-properties

DELETE /config-properties/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of config-properties

GET /config-propertiess

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new config-properties

POST /config-propertiess

Parameters

Type	Name	Description	Schema	Default
body	config-properties required	Body of config-properties resource	ConfigPropertiesCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

config-root

Data Model

Description

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Attribute attached to objects - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific config-root

GET /config-root/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ConfigRootReadAll
404	Not Found	Error

Update a specific config-root

PUT /config-root/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	config-root optional		ConfigRootUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific config-root

DELETE /config-root/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of config-root

GET /config-roots

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new config-root

POST /config-roots

Parameters

Type	Name	Description	Schema	Default
body	config-root required	Body of config-root resource	ConfigRootCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

control-node-zone

Data Model

Description

List of references to all control-node-zones in systems.

Parents: global-system-config

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:bgp-as-a-service bgp-as-a-service-label, :ref:bgp-router bgp-router-label

REST API

Fetch a specific control-node-zone

GET /control-node-zone/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ControlNodeZoneReadAll
404	Not Found	Error

Update a specific control-node-zone

PUT /control-node-zone/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	control-node-zone optional		ControlNodeZoneUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific control-node-zone

DELETE /control-node-zone/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of control-node-zone

GET /control-node-zones

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new control-node-zone

POST /control-node-zones

Parameters

Type	Name	Description	Schema	Default
body	control-node-zone required	Body of control-node-zone resource	ControlNodeZoneCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

customer-attachment

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
attachment-address	None	False	AttachmentAddressType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-machine-interface virtual-machine-interface-label	Not in Use.	False	None	CRUD	user
:ref:floating-ip floating-ip-label	Not in Use.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific customer-attachment

GET /customer-attachment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	CustomerAttachmentReadAll
404	Not Found	Error

Update a specific customer-attachment

PUT /customer-attachment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	customer-attachment optional		CustomerAttachmentUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific customer-attachment

DELETE /customer-attachment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of customer-attachment

GET /customer-attachments

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new customer-attachment

POST /customer-attachments

Parameters

Type	Name	Description	Schema	Default
body	customer-attachment required	Body of customer-attachment resource	CustomerAttachmentCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

data-center-interconnect

Data Model

Description

List of DCI Objects in the system. Each DCI represents an interconnect of Multiple Fabrics or interconnect of LRs in same fabric.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
data-center-interconnect-bgp-hold-time	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds.	False	number	CRUD	user
data-center-interconnect-mode	Data Center InterConnect modes can be l2 or l3. l2 - DCI mode l2 stretch. l3 - DCI mode l3 stretch.	False	string	CRUD	user
data-center-interconnect-bgp-address-families	BGP address families supported by BGP router.	False	AddressFamilies	CRUD	user
data-center-interconnect-configured-route-target-list	List of route targets that represent this logical router, all virtual networks connected to this DCI will have this as their route target list.	False	RouteTargetList	CRUD	user
data-center-interconnect-type	Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.	False	string	CRUD	user
destination-physical-router-list	holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object	False	LogicalRouterPRListType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:logical-router logical-router-label	List of LRs one from each fabric participating in the DCI, each LR belongs to different fabric	False	None	CRUD	user
:ref:virtual-network virtual-network-label	reference to auto created internal virtual network, used for connecting different data centers for DCI type inter-fabric and intra-fabric. For intra-fabric type DCI, if user does not provided any DCI-routing-policy then this refs holds list of tenant virtual networks refs provided and selected by users. this refs will be list of tenant VN which existed in source LR for intra-fabric type DCI. routes will be leak only for this list of VNs subnets in intra-fabric DCI.	False	None	CRUD	user
:ref:routing-policy routing-policy-label	Used only if DCI-type is intra-fabric. it stores the List of routing policies for this DCI to be used as import policies between logical routers. if any single or more routing policy defined in this property then DCI-virtual-network-refs property value will be ignored for route leaks route- filter.	False	None	CRUD	user
:ref:fabric fabric-label	Reference to fabric, this link enables to identify which fabric this DCI belongs to. This refs used for l2 mode inter-fabric dci	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific data-center-interconnect

GET /data-center-interconnect/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DataCenterInterconnectReadAll
404	Not Found	Error

Update a specific data-center-interconnect

PUT /data-center-interconnect/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	data-center-interconnect optional		DataCenterInterconnectUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific data-center-interconnect

DELETE /data-center-interconnect/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of data-center-interconnect

GET /data-center-interconnects

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new data-center-interconnect

POST /data-center-interconnects

Parameters

Type	Name	Description	Schema	Default
body	data-center-interconnect required	Body of data-center-interconnect resource	DataCenterInterconnectCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

database-node

Data Model

Description

Database node is object representing a logical node in system which host Cassandra DB and Zookeeper.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
database-node-ip-address	Ip address of the database node, set while provisioning.	True	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific config-database-node

GET /config-database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ConfigDatabaseNodeReadAll
404	Not Found	Error

Update a specific config-database-node

PUT /config-database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	config-database-node optional		ConfigDatabaseNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific config-database-node

DELETE /config-database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of config-database-node

GET /config-database-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new config-database-node

POST /config-database-nodes

Parameters

Type	Name	Description	Schema	Default
body	config-database-node required	Body of config-database-node resource	ConfigDatabaseNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific database-node

GET /database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DatabaseNodeReadAll
404	Not Found	Error

Update a specific database-node

PUT /database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	database-node optional		DatabaseNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific database-node

DELETE /database-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of database-node

GET /database-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new database-node

POST /database-nodes

Parameters

Type	Name	Description	Schema	Default
body	database-node required	Body of database-node resource	DatabaseNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

device-chassis

Data Model

Description

This resource contains information about the device chassis. The PR can refer to this object for chassis details. This resource name must follow the convention: ‘vendorname_chassismac’ (replacing mac ‘:’ with ‘_’), for example, ‘juniper_00_11_22_33_44_55’

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
device-chassis-type	type of the chassis address if known.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:physical-router physical-router-label

REST API

Fetch a specific device-chassis

GET /device-chassis/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DeviceChassisReadAll
404	Not Found	Error

Update a specific device-chassis

PUT /device-chassis/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	device-chassis optional		DeviceChassisUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific device-chassis

DELETE /device-chassis/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of device-chassis

GET /device-chassiss

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new device-chassis

POST /device-chassiss

Parameters

Type	Name	Description	Schema	Default
body	device-chassis required	Body of device-chassis resource	DeviceChassisCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

device-functional-group

Data Model

Description

Device functional group is used to group together any selected list of devices for the purpose of assigning identical attributes. For example, os-version, physical-roles, rb-roles

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
device-functional-group-description	Description of the functional group stating the functionality the devices would get if assigned to this group	False	string	CRUD	user
device-functional-group-os-version	OS version for devices in this group. If set, it is the first choice for device image upgrade during ztp. If not set, fabric-os-version is used	False	string	CRUD	user
device-functional-group-routing-bridging-roles	Routing-bridging role (e.g. CRB, ERB, etc.), used by the device manager to provision physical router, for e.g device manager may choose to configure physical router based on its role.	False	RoutingBridgingRolesType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:physical-role physical-role-label	Physical role assigned to all physical routers which are members of this device functional group	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:physical-router physical-router-label

REST API

Fetch a specific device-functional-group

GET /device-functional-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DeviceFunctionalGroupReadAll
404	Not Found	Error

Update a specific device-functional-group

PUT /device-functional-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	device-functional-group optional		DeviceFunctionalGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific device-functional-group

DELETE /device-functional-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of device-functional-group

GET /device-functional-groups

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new device-functional-group

POST /device-functional-groups

Parameters

Type	Name	Description	Schema	Default
body	device-functional-group required	Body of device-functional-group resource	DeviceFunctionalGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

device-image

Data Model

Description

list of device image info for the images that get uploaded to the system.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
device-image-file-name	Name of the device image. As of now, for Juniper devices, it will be used by device manager during image upgrade to send additional flag for vmhost based REs.	False	string	CRUD	user
device-image-vendor-name	Vendor name for device image. It is used by device manager during device image upgrade to match the PRouters vendor name	True	string	CRUD	user
device-image-device-family	Device family name for device image. It is used by device manager during device image upgrade to match the family name of the PRouter	True	string	CRUD	user
device-image-supported-platforms	List of device platforms that this image can be installed on. It is used by device manager during device image upgrade validate the PRouters product_name property. If this property is not specified, then this image can be installed on all platforms of the device family	False	DevicePlatformListType	CRUD	user
device-image-os-version	OS version string on the device where this image is installed. This version string should match the PRouters operational state PRouterUVE.os_version attribute if the image is successfully installed on the PRouter	True	string	CRUD	user
device-image-file-uri	file uri for the device image uploaded to the image server.	False	string	CRUD	user
device-image-size	file size of the device image that was uploaded to the image server.	False	number	CRUD	user
device-image-md5	md5 checksum of the image file that was uploaded to the image server.	False	string	CRUD	user
device-image-sha1	sha1 checksum of the image file that was uploaded to the image server.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:hardware hardware-label	linking the hardware that is associated to image	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:physical-router physical-router-label

REST API

Fetch a specific device-image

GET /device-image/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DeviceImageReadAll
404	Not Found	Error

Update a specific device-image

PUT /device-image/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	device-image optional		DeviceImageUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific device-image

DELETE /device-image/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of device-image

GET /device-images

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new device-image

POST /device-images

Parameters

Type	Name	Description	Schema	Default
body	device-image required	Body of device-image resource	DeviceImageCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

devicemgr-node

Data Model

Description

devicemgr node is object representing a logical node in system for configuring physical devices.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
devicemgr-node-ip-address	Ip address of the devicemgr node, set while provisioning.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific devicemgr-node

GET /devicemgr-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DevicemgrNodeReadAll
404	Not Found	Error

Update a specific devicemgr-node

PUT /devicemgr-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	devicemgr-node optional		DevicemgrNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific devicemgr-node

DELETE /devicemgr-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of devicemgr-node

GET /devicemgr-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new devicemgr-node

POST /devicemgr-nodes

Parameters

Type	Name	Description	Schema	Default
body	devicemgr-node required	Body of devicemgr-node resource	DevicemgrNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

discovery-service-assignment

Data Model

Description

Parents: None

Children

dsa-rule

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific discovery-service-assignment

GET /discovery-service-assignment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DiscoveryServiceAssignmentReadAll
404	Not Found	Error

Update a specific discovery-service-assignment

PUT /discovery-service-assignment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	discovery-service-assignment optional		DiscoveryServiceAssignmentUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific discovery-service-assignment

DELETE /discovery-service-assignment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of discovery-service-assignment

GET /discovery-service-assignments

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new discovery-service-assignment

POST /discovery-service-assignments

Parameters

Type	Name	Description	Schema	Default
body	discovery-service-assignment required	Body of discovery-service-assignment resource	DiscoveryServiceAssignmentCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

domain

Data Model

Description

Parents: None

Children

api-access-list, namespace, project, service-template, virtual-DNS

Properties

Name	Description	Required	Type	Operations	Created By
domain-limits	Domain level quota, not currently implemented	False	DomainLimitsType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific bridge-domain

GET /bridge-domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	BridgeDomainReadAll
404	Not Found	Error

Update a specific bridge-domain

PUT /bridge-domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	bridge-domain optional		BridgeDomainUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific bridge-domain

DELETE /bridge-domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of bridge-domain

GET /bridge-domains

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new bridge-domain

POST /bridge-domains

Parameters

Type	Name	Description	Schema	Default
body	bridge-domain required	Body of bridge-domain resource	BridgeDomainCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific domain

GET /domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DomainReadAll
404	Not Found	Error

Update a specific domain

PUT /domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	domain optional		DomainUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific domain

DELETE /domain/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of domain

GET /domains

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new domain

POST /domains

Parameters

Type	Name	Description	Schema	Default
body	domain required	Body of domain resource	DomainCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

dsa-rule

Data Model

Description

Discovery service rule for assigning subscriber to publisher. (set of subscriber) can be assigned to (set of publisher).

Parents: discovery-service-assignment

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
dsa-rule-entry	rule entry defining publisher set and subscriber set.	True	DiscoveryServiceAssignmentType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific dsa-rule

GET /dsa-rule/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	DsaRuleReadAll
404	Not Found	Error

Update a specific dsa-rule

PUT /dsa-rule/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	dsa-rule optional		DsaRuleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific dsa-rule

DELETE /dsa-rule/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of dsa-rule

GET /dsa-rules

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new dsa-rule

POST /dsa-rules

Parameters

Type	Name	Description	Schema	Default
body	dsa-rule required	Body of dsa-rule resource	DsaRuleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

e2-service-provider

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
e2-service-provider-promiscuous	This service provider is connected to all other service providers.	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:peering-policy peering-policy-label	Links the service provider to a peering policy.	False	None	CRUD	user
:ref:physical-router physical-router-label	Links the service provider to peer routers.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific e2-service-provider

GET /e2-service-provider/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	E2ServiceProviderReadAll
404	Not Found	Error

Update a specific e2-service-provider

PUT /e2-service-provider/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	e2-service-provider optional		E2ServiceProviderUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific e2-service-provider

DELETE /e2-service-provider/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of e2-service-provider

GET /e2-service-providers

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new e2-service-provider

POST /e2-service-providers

Parameters

Type	Name	Description	Schema	Default
body	e2-service-provider required	Body of e2-service-provider resource	E2ServiceProviderCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

fabric

Data Model

Description

List of fabrics in the system. Each fabric is an administrative domain for all the network devices in one or multiple CLOS.

Parents: global-system-config

Children

fabric-namespace, virtual-port-group

Properties

Name	Description	Required	Type	Operations	Created By
fabric-ztp	This attribute to indicate if the fabric is zero-touch provisioned or not. If this attribute is set to ‘True’, user should not be allowed to remove any existing namespaces from the fabric as they may be used to provision the devices.	False	boolean	CRUD	user
fabric-os-version	OS version of the entire fabric. It is updated when image upgrade is chosen during ztp.	False	string	CRUD	user
fabric-credentials	List of device credentials to manage the network devices in the fabric.	False	DeviceCredentialList	CRUD	user
fabric-enterprise-style	This attribute indicates whether to use enterprise-style or sp-style configuration in the fabric. True indicated enterprise-style.	False	boolean	CRUD	user
disable-vlan-vn-uniqueness-check	This attribute indicates whether complex validations for VLAN-VN uniqueness check should be done for enterprise style VPGs in the fabric. Default behaviour is to enable all the validations.	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:intent-map intent-map-label	Fabric that belongs to this intent map	False	None	CRUD	user
:ref:virtual-network virtual-network-label	Similar to using virtual-machine to model the bare metal server, we are using virtual-network to model various underlay networks such as the management network and IP fabric network. This would allow us the re-use the same IPAM data model and code base to manage the IP auto-assignments for the underlay physical networks.	False	FabricNetworkTag	CRUD	user
:ref:node-profile node-profile-label	node profiles assignd to the fabric. The serial number list on the link is used to auto assign node- profile during ZTP so that port channelization could be bootstrapped based on the hardware spec in the node profile.	False	SerialNumListType	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:physical-router physical-router-label, :ref:logical-router logical-router-label, :ref:data-center-interconnect data-center-interconnect-label

REST API

Fetch a specific fabric

GET /fabric/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FabricReadAll
404	Not Found	Error

Update a specific fabric

PUT /fabric/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	fabric optional		FabricUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific fabric

DELETE /fabric/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of fabric

GET /fabrics

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new fabric

POST /fabrics

Parameters

Type	Name	Description	Schema	Default
body	fabric required	Body of fabric resource	FabricCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific fabric-namespace

GET /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FabricNamespaceReadAll
404	Not Found	Error

Update a specific fabric-namespace

PUT /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	fabric-namespace optional		FabricNamespaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific fabric-namespace

DELETE /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of fabric-namespace

GET /fabric-namespaces

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new fabric-namespace

POST /fabric-namespaces

Parameters

Type	Name	Description	Schema	Default
body	fabric-namespace required	Body of fabric-namespace resource	FabricNamespaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

fabric-namespace

Data Model

Description

list of fabric namespaces that define a set of resources that can be used to configure the network devices in the fabric.

Parents: fabric

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
fabric-namespace-type	Supported namespace types	False	string	CRUD	user
fabric-namespace-value	namespace value of type defined by the namespace-type.	False	NamespaceValue	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific fabric-namespace

GET /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FabricNamespaceReadAll
404	Not Found	Error

Update a specific fabric-namespace

PUT /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	fabric-namespace optional		FabricNamespaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific fabric-namespace

DELETE /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of fabric-namespace

GET /fabric-namespaces

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new fabric-namespace

POST /fabric-namespaces

Parameters

Type	Name	Description	Schema	Default
body	fabric-namespace required	Body of fabric-namespace resource	FabricNamespaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

feature

Data Model

Description

A granual networking feature supported by Fabric Manager

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:feature feature-label	list of features this feature is dependent on.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:role-definition role-definition-label

REST API

Fetch a specific feature

GET /feature/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FeatureReadAll
404	Not Found	Error

Update a specific feature

PUT /feature/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	feature optional		FeatureUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific feature

DELETE /feature/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of feature

GET /features

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new feature

POST /features

Parameters

Type	Name	Description	Schema	Default
body	feature required	Body of feature resource	FeatureCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific feature-config

GET /feature-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FeatureConfigReadAll
404	Not Found	Error

Update a specific feature-config

PUT /feature-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	feature-config optional		FeatureConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific feature-config

DELETE /feature-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of feature-config

GET /feature-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new feature-config

POST /feature-configs

Parameters

Type	Name	Description	Schema	Default
body	feature-config required	Body of feature-config resource	FeatureConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific feature-flag

GET /feature-flag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FeatureFlagReadAll
404	Not Found	Error

Update a specific feature-flag

PUT /feature-flag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	feature-flag optional		FeatureFlagUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific feature-flag

DELETE /feature-flag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of feature-flag

GET /feature-flags

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new feature-flag

POST /feature-flags

Parameters

Type	Name	Description	Schema	Default
body	feature-flag required	Body of feature-flag resource	FeatureFlagCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

feature-config

Data Model

Description

Vendor specific and/or feature specific configuration parameters editable by the user

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
feature-config-additional-params	Additional configuration parameters for the feature.	False	KeyValuePairs	CRUD	user
feature-config-vendor-config	Vendor specific configuration/parameters for the feature.	False	KeyValuePairs	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific feature-config

GET /feature-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FeatureConfigReadAll
404	Not Found	Error

Update a specific feature-config

PUT /feature-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	feature-config optional		FeatureConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific feature-config

DELETE /feature-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of feature-config

GET /feature-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new feature-config

POST /feature-configs

Parameters

Type	Name	Description	Schema	Default
body	feature-config required	Body of feature-config resource	FeatureConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

feature-flag

Data Model

Description

Feature Flag to swtich on/off the allowed feature

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
feature-description	short explanation about the feature.	False	string	R	system
feature-id	identifier for this feature	True	string	CRUD	user
feature-flag-version	contrail release in which this feature flag is created.	True	string	CRUD	user
feature-release	version of release in which the feature is introduced.	False	string	R	system
enable-feature	knob to enable or disable an allowed feature.	False	boolean	CRUD	user
feature-state	state of the feature	False	string	R	system

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific feature-flag

GET /feature-flag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FeatureFlagReadAll
404	Not Found	Error

Update a specific feature-flag

PUT /feature-flag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	feature-flag optional		FeatureFlagUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific feature-flag

DELETE /feature-flag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of feature-flag

GET /feature-flags

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new feature-flag

POST /feature-flags

Parameters

Type	Name	Description	Schema	Default
body	feature-flag required	Body of feature-flag resource	FeatureFlagCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

firewall-policy

Data Model

Description

When parent is policy-management,

firewall-policy object consisting of one or more firewall rules

When parent is project,

Project level firewall-policy object consisting of one or more firewall rules

Parents: policy-management, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
draft-mode-state	None	False	string	R	user

References

To	Description	Required	Type	Operations	Created By
:ref:firewall-rule firewall-rule-label	Reference to firewall-rule attached to this firewall-policy	False	FirewallSequence	CRUD	user
:ref:security-logging-object security-logging-object-label	Reference to security-logging-object attached to this firewall-policy	False	SloRateType	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:application-policy-set application-policy-set-label

REST API

Fetch a specific firewall-policy

GET /firewall-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FirewallPolicyReadAll
404	Not Found	Error

Update a specific firewall-policy

PUT /firewall-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	firewall-policy optional		FirewallPolicyUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific firewall-policy

DELETE /firewall-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of firewall-policy

GET /firewall-policys

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new firewall-policy

POST /firewall-policys

Parameters

Type	Name	Description	Schema	Default
body	firewall-policy required	Body of firewall-policy resource	FirewallPolicyCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

firewall-rule

Data Model

Description

When parent is policy-management,

Firewall-rule object

When parent is project,

Project level firewall-rule object

Parents: policy-management, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
draft-mode-state	None	False	string	R	user
action-list	Actions to be performed if packets match condition	True	ActionListType	CRUD	user
service	Service (port, protocol) for packets match condition	False	FirewallServiceType	CRUD	user
endpoint-1	match condition for traffic source	True	FirewallRuleEndpointType	CRUD	user
endpoint-2	match condition for traffic destination	True	FirewallRuleEndpointType	CRUD	user
match-tags	matching tags for source and destination endpoints	True	FirewallRuleMatchTagsType	CRUD	user
match-tag-types	matching tags ids for source and destination endpoints	True	FirewallRuleMatchTagsTypeIdList	R	user
direction	Direction in the rule	True	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-group service-group-label	Reference to service-group attached to this firewall policy	False	None	CRUD	user
:ref:address-group address-group-label	Reference to address group attached to endpoints	False	None	R	user
:ref:virtual-network virtual-network-label	Reference to virtual network attached to endpoints	False	None	R	user
:ref:security-logging-object security-logging-object-label	Reference to security-logging-object attached to this firewall-rule	False	SloRateType	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:firewall-policy firewall-policy-label

REST API

Fetch a specific firewall-rule

GET /firewall-rule/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FirewallRuleReadAll
404	Not Found	Error

Update a specific firewall-rule

PUT /firewall-rule/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	firewall-rule optional		FirewallRuleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific firewall-rule

DELETE /firewall-rule/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of firewall-rule

GET /firewall-rules

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new firewall-rule

POST /firewall-rules

Parameters

Type	Name	Description	Schema	Default
body	firewall-rule required	Body of firewall-rule resource	FirewallRuleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

floating-ip

Data Model

Description

When parent is floating-ip-pool,

Floating ip is a ip that can be assigned to (virtual machine interface(VMI), ip), By doing so VMI can no be part of the floating ip network and floating ip is used as one:one to NAT for doing so.

When parent is instance-ip,

floating-ip can be child of instance-ip. By doing so instance-ip can be used as floating-ip.

Parents: floating-ip-pool, instance-ip

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
floating-ip-address	Floating ip address.	True	string	CR	user
floating-ip-is-virtual-ip	This floating ip is used as virtual ip (VIP) in case of LBaaS.	False	boolean	CRUD	user
floating-ip-fixed-ip-address	This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.	False	string	CRUD	user
floating-ip-address-family	Ip address family of the floating ip, IpV4 or IpV6	False	string	CRUD	user
floating-ip-port-mappings-enable	If it is false, floating-ip Nat is done for all Ports. If it is true, floating-ip Nat is done to the list of PortMaps.	False	boolean	CRUD	user
floating-ip-port-mappings	List of PortMaps for this floating-ip.	False	PortMappings	CRUD	user
floating-ip-traffic-direction	Specifies direction of traffic for the floating-ip	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:project project-label	Reference to project is which this floating ip was allocated.	True	None	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to virtual machine interface to which this floating ip is attached.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:customer-attachment customer-attachment-label

REST API

Fetch a specific floating-ip

GET /floating-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FloatingIpReadAll
404	Not Found	Error

Update a specific floating-ip

PUT /floating-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	floating-ip optional		FloatingIpUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific floating-ip

DELETE /floating-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of floating-ip

GET /floating-ips

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new floating-ip

POST /floating-ips

Parameters

Type	Name	Description	Schema	Default
body	floating-ip required	Body of floating-ip resource	FloatingIpCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific floating-ip-pool

GET /floating-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FloatingIpPoolReadAll
404	Not Found	Error

Update a specific floating-ip-pool

PUT /floating-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	floating-ip-pool optional		FloatingIpPoolUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific floating-ip-pool

DELETE /floating-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of floating-ip-pool

GET /floating-ip-pools

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new floating-ip-pool

POST /floating-ip-pools

Parameters

Type	Name	Description	Schema	Default
body	floating-ip-pool required	Body of floating-ip-pool resource	FloatingIpPoolCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

floating-ip-pool

Data Model

Description

Floating ip pool is set of ip address that are carved out of a given network. Ip(s) from this set can be assigned to (virtual machine interface, ip) so that they become members of this network using one:one NAT.

Parents: virtual-network

Children

floating-ip

Properties

Name	Description	Required	Type	Operations	Created By
floating-ip-pool-subnets	Subnets that restrict floating ip allocation from the corresponding virtual network.	False	FloatingIpPoolSubnetType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:project project-label

REST API

Fetch a specific floating-ip-pool

GET /floating-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FloatingIpPoolReadAll
404	Not Found	Error

Update a specific floating-ip-pool

PUT /floating-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	floating-ip-pool optional		FloatingIpPoolUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific floating-ip-pool

DELETE /floating-ip-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of floating-ip-pool

GET /floating-ip-pools

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new floating-ip-pool

POST /floating-ip-pools

Parameters

Type	Name	Description	Schema	Default
body	floating-ip-pool required	Body of floating-ip-pool resource	FloatingIpPoolCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

flow-node

Data Model

Description

Appformix flows node is object representing a logical node in system which serves xflow collectors.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
flow-node-ip-address	Ip address of the appformix flow node, set while provisioning.	False	string	CRUD	user
flow-node-load-balancer-ip	IP address of the load balancer node for xflow collectors, set while provisioning.	True	string	CRUD	user
flow-node-inband-interface	In-Band interface name used for this flow node.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-network virtual-network-label	Similar to using virtual-machine to model the bare metal server, we are using virtual-network to model telemetry underlay infra network. This would allow us to re-use the same IPAM data model and code base to manage the IP auto-assignments for the underlay telemetry networks.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:instance-ip instance-ip-label

REST API

Fetch a specific flow-node

GET /flow-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FlowNodeReadAll
404	Not Found	Error

Update a specific flow-node

PUT /flow-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	flow-node optional		FlowNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific flow-node

DELETE /flow-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of flow-node

GET /flow-nodes

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new flow-node

POST /flow-nodes

Parameters

Type	Name	Description	Schema	Default
body	flow-node required	Body of flow-node resource	FlowNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

forwarding-class

Data Model

Description

Link to global-qos config.

Parents: global-qos-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
forwarding-class-id	Unique ID for this forwarding class.	True	number	CRUD	user
forwarding-class-dscp	DSCP value to be written on outgoing packet for this forwarding-class.	True	number	CRUD	user
forwarding-class-vlan-priority	802.1p value to be written on outgoing packet for this forwarding-class.	True	number	CRUD	user
forwarding-class-mpls-exp	MPLS exp value to be written on outgoing packet for this forwarding-class.	True	number	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:qos-queue qos-queue-label	Qos queue to be used for this forwarding class.	True	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific forwarding-class

GET /forwarding-class/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	ForwardingClassReadAll
404	Not Found	Error

Update a specific forwarding-class

PUT /forwarding-class/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	forwarding-class optional		ForwardingClassUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific forwarding-class

DELETE /forwarding-class/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of forwarding-class

GET /forwarding-classs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new forwarding-class

POST /forwarding-classs

Parameters

Type	Name	Description	Schema	Default
body	forwarding-class required	Body of forwarding-class resource	ForwardingClassCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

global-analytics-config

Data Model

Description

global analytics config related data

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific global-analytics-config

GET /global-analytics-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	GlobalAnalyticsConfigReadAll
404	Not Found	Error

Update a specific global-analytics-config

PUT /global-analytics-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	global-analytics-config optional		GlobalAnalyticsConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific global-analytics-config

DELETE /global-analytics-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of global-analytics-config

GET /global-analytics-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new global-analytics-config

POST /global-analytics-configs

Parameters

Type	Name	Description	Schema	Default
body	global-analytics-config required	Body of global-analytics-config resource	GlobalAnalyticsConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

global-qos-config

Data Model

Description

Global QoS system config is object where all global system QoS configuration is present.

Parents: global-system-config

Children

forwarding-class, qos-config, qos-queue

Properties

Name	Description	Required	Type	Operations	Created By
control-traffic-dscp	DSCP value of IP header for control traffic	True	ControlTrafficDscpType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific global-qos-config

GET /global-qos-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	GlobalQosConfigReadAll
404	Not Found	Error

Update a specific global-qos-config

PUT /global-qos-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	global-qos-config optional		GlobalQosConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific global-qos-config

DELETE /global-qos-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of global-qos-config

GET /global-qos-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new global-qos-config

POST /global-qos-configs

Parameters

Type	Name	Description	Schema	Default
body	global-qos-config required	Body of global-qos-config resource	GlobalQosConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

global-system-config

Data Model

Description

Parents: None

Children

alarm, analytics-alarm-node, analytics-node, analytics-snmp-node, api-access-list, config-database-node, config-node, config-properties, control-node-zone, data-center-interconnect, database-node, device-image, devicemgr-node, fabric, flow-node, global-qos-config, global-vrouter-config, intent-map, job-template, node, physical-router, service-appliance-set, virtual-router, webui-node

Properties

Name	Description	Required	Type	Operations	Created By
autonomous-system	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	True	number	CRUD	user
enable-4byte-as	Knob to enable 4 byte Autonomous System number support.	False	boolean	CRUD	user
config-version	Version of OpenContrail software that generated this config.	False	string	R	system
graceful-restart-parameters	Graceful Restart parameters	False	GracefulRestartParametersType	CRUD	user
fast-convergence-parameters	Fast Convergence parameters.	False	FastConvergenceParametersType	CRUD	user
plugin-tuning	Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.	False	PluginProperties	CRUD	user
data-center-interconnect-loopback-namespace	Used for assigning loopback addresses on interconnect physical devices.	False	SubnetListType	CRUD	user
data-center-interconnect-asn-namespace	Used for assigning asn values on interconnect physical devices.	False	AsnRangeType	CRUD	user
ibgp-auto-mesh	When true, system will automatically create BGP peering mesh with all control-nodes that have same BGP AS number as global AS number.	False	boolean	CRUD	user
bgp-always-compare-med	Always compare MED even if paths are received from different ASes.	False	boolean	CRUD	user
rd-cluster-seed	Used to create collision-free route distinguishers.	False	number	CRUD	user
route-replication-threshold	Time to wait (in minutes) before enabling optimisation in route replication.	False	number	CRUD	user
ip-fabric-subnets	List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic GRE tunnels on the SDN gateway.	False	SubnetListType	CRUD	user
supported-device-families	List of all supported physical router device family names. Used by UI to show pick list.	False	DeviceFamilyListType	CRUD	user
supported-vendor-hardwares	List of all supported vendor hardware platforms by the system. Used by UI to show pick list.	False	VendorHardwaresType	CRUD	user
bgpaas-parameters	BGP As A Service Parameters configuration	False	BGPaaServiceParametersType	CRUD	user
mac-limit-control	MAC limit control on the network	False	MACLimitControlType	CRUD	user
mac-move-control	MAC move control on the network	False	MACMoveLimitControlType	CRUD	user
mac-aging-time	MAC aging time on the network	False	number	CRUD	user
igmp-enable	IGMP mode at Global level.	False	boolean	CRUD	user
alarm-enable	Flag to enable/disable alarms configured under global-system-config. True, if not set.	False	boolean	CRUD	user
user-defined-log-statistics	stats name and patterns	False	UserDefinedLogStatList	CRUD	user
enable-security-policy-draft	None	False	boolean	CRUD	user
supported-fabric-annotations	List of supported annotations that can be used to annotate a Contrail Fabric. These annoations are used as directives, or hints to assign resources defined in namespaces to the network devices. For example, igp-protocol: ospf attribute could be used by the underlay provisioning playbook to choose which IGP protocol to use for the IP fabric.	False	KeyValuePairs	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:bgp-router bgp-router-label	List of references to all bgp routers in systems.	True	None	R	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:qos-config qos-config-label

REST API

Fetch a specific global-system-config

GET /global-system-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	GlobalSystemConfigReadAll
404	Not Found	Error

Update a specific global-system-config

PUT /global-system-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	global-system-config optional		GlobalSystemConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific global-system-config

DELETE /global-system-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of global-system-config

GET /global-system-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new global-system-config

POST /global-system-configs

Parameters

Type	Name	Description	Schema	Default
body	global-system-config required	Body of global-system-config resource	GlobalSystemConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

global-vrouter-config

Data Model

Description

Global vrouter config is object where all global vrouter config is present.

Parents: global-system-config

Children

security-logging-object

Properties

Name	Description	Required	Type	Operations	Created By
ecmp-hashing-include-fields	ECMP hashing config at global level.	False	EcmpHashingIncludeFields	CRUD	user
linklocal-services	Global services provided on link local subnet to the virtual machines.	False	LinklocalServicesTypes	CRUD	user
encapsulation-priorities	Ordered list of encapsulations that vrouter will use in priority order.	False	EncapsulationPrioritiesType	CRUD	user
vxlan-network-identifier-mode	Method of allocation of VxLAN VNI(s). Set at provision time and cannot be changed. configured = VxLAN VNI is given by user when virtual network is configured. automatic = System will allocate VxLAN VNI automatically.	False	string	CRUD	user
flow-export-rate	Flow export rate is global config, rate at which each vrouter will sample and export flow records to analytics	False	number	CRUD	user
flow-aging-timeout-list	Flow aging timeout per application (protocol, port) list.	False	FlowAgingTimeoutList	CRUD	user
enable-security-logging	Enable or disable security-logging in the system	False	boolean	CRUD	user
encryption-mode	Enable encryption mode	False	string	CRUD	user
encryption-tunnel-endpoints	Encryption tunnel endpoints list	False	EncryptionTunnelEndpointList	CRUD	user
forwarding-mode	Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.	False	string	CRUD	user
port-translation-pools	List of Ports to be reserved for providing underlay connectivity via Port translation.	False	PortTranslationPools	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:application-policy-set application-policy-set-label

REST API

Fetch a specific global-vrouter-config

GET /global-vrouter-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	GlobalVrouterConfigReadAll
404	Not Found	Error

Update a specific global-vrouter-config

PUT /global-vrouter-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	global-vrouter-config optional		GlobalVrouterConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific global-vrouter-config

DELETE /global-vrouter-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of global-vrouter-config

GET /global-vrouter-configs

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new global-vrouter-config

POST /global-vrouter-configs

Parameters

Type	Name	Description	Schema	Default
body	global-vrouter-config required	Body of global-vrouter-config resource	GlobalVrouterConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

grpc-profile

Data Model

Description

This resource contains information specific to grpc parameters

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
grpc-profile-is-default	This attribute indicates whether it is a default grpc profile or not. Default profiles are non- editable.	False	boolean	CRUD	user
grpc-parameters	Parameters for each grpc profile, such as allow client, top level sensor options etc.	False	GrpcParameters	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:telemetry-profile telemetry-profile-label

REST API

Fetch a specific grpc-profile

GET /grpc-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	GrpcProfileReadAll
404	Not Found	Error

Update a specific grpc-profile

PUT /grpc-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	grpc-profile optional		GrpcProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific grpc-profile

DELETE /grpc-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of grpc-profile

GET /grpc-profiles

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new grpc-profile

POST /grpc-profiles

Parameters

Type	Name	Description	Schema	Default
body	grpc-profile required	Body of grpc-profile resource	GrpcProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

hardware

Data Model

Description

This resource contains the information about the device hardware info. This resource name must follow the convention: ‘[vendor name]-[hardware platform name]’, for example, ‘juniper-mx80’.

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:card card-label	List of installed interface cards in a specific hardware platform.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:node-profile node-profile-label, :ref:device-image device-image-label

REST API

Fetch a specific hardware

GET /hardware/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	HardwareReadAll
404	Not Found	Error

Update a specific hardware

PUT /hardware/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	hardware optional		HardwareUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific hardware

DELETE /hardware/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of hardware

GET /hardwares

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new hardware

POST /hardwares

Parameters

Type	Name	Description	Schema	Default
body	hardware required	Body of hardware resource	HardwareCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific hardware-inventory

GET /hardware-inventory/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	HardwareInventoryReadAll
404	Not Found	Error

Update a specific hardware-inventory

PUT /hardware-inventory/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	hardware-inventory optional		HardwareInventoryUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific hardware-inventory

DELETE /hardware-inventory/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of hardware-inventory

GET /hardware-inventorys

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new hardware-inventory

POST /hardware-inventorys

Parameters

Type	Name	Description	Schema	Default
body	hardware-inventory required	Body of hardware-inventory resource	HardwareInventoryCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

hardware-inventory

Data Model

Description

Hardware Inventory on a physical router.

Parents: physical-router

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
hardware-inventory-inventory-info	chassis inventory info of the physical router. Stored as json string. Will be used to render chassis hardware details in UI	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific hardware-inventory

GET /hardware-inventory/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	HardwareInventoryReadAll
404	Not Found	Error

Update a specific hardware-inventory

PUT /hardware-inventory/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	hardware-inventory optional		HardwareInventoryUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific hardware-inventory

DELETE /hardware-inventory/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of hardware-inventory

GET /hardware-inventorys

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new hardware-inventory

POST /hardware-inventorys

Parameters

Type	Name	Description	Schema	Default
body	hardware-inventory required	Body of hardware-inventory resource	HardwareInventoryCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

host-based-service

Data Model

Description

Project level host based service.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
host-based-service-type	Defines which host based service type is used, cannot not be updated.	False	string	CR	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-network virtual-network-label	Reference to virtual network attached to the HBS tagged mangement, left, right, other*. only one ref per tag type.	False	ServiceVirtualNetworkType	R	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific host-based-service

GET /host-based-service/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	HostBasedServiceReadAll
404	Not Found	Error

Update a specific host-based-service

PUT /host-based-service/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	host-based-service optional		HostBasedServiceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific host-based-service

DELETE /host-based-service/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of host-based-service

GET /host-based-services

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new host-based-service

POST /host-based-services

Parameters

Type	Name	Description	Schema	Default
body	host-based-service required	Body of host-based-service resource	HostBasedServiceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

instance-ip

Data Model

Description

Parents: None

Children

floating-ip

Properties

Name	Description	Required	Type	Operations	Created By
instance-ip-address	Ip address value for instance ip.	True	string	CR	user
instance-ip-family	Ip address family for instance ip, IPv4(v4) or IPv6(v6).	False	string	CR	user
instance-ip-mode	Ip address HA mode in case this instance ip is used in more than one interface, active-Active or active-Standby.	False	string	CR	user
secondary-ip-tracking-ip	When this instance ip is secondary ip, it can track activeness of another ip.	False	SubnetType	CRUD	user
subnet-uuid	This instance ip was allocated from this Subnet(UUID).	False	string	CR	user
instance-ip-subscriber-tag	This instance ip belongs to one of the subscribers in the subscriber-tag.	False	string	CR	user
instance-ip-secondary	This instance ip is secondary ip of the interface.	False	boolean	CRUD	user
instance-ip-local-ip	This instance ip is local to compute and will not be exported to other nodes.	False	boolean	CRUD	user
service-instance-ip	This instance ip is used as service chain next hop	False	boolean	CRUD	system
service-health-check-ip	This instance ip is used as service health check source ip	False	boolean	CRUD	system
instance-ip-subnet	Ip prefix/length of the subnet where instance-ip belongs.	False	SubnetType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-network virtual-network-label	Reference to virtual network of this instance ip.	True	None	CRUD	user
:ref:network-ipam network-ipam-label	Reference to network ipam of this instance ip.	True	None	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to virtual machine interface to which this instance ip is attached.	False	None	CRUD	user
:ref:physical-router physical-router-label	This instance ip is used as IRB address on the referenced physical router (e.g.MX), In case of OVSDB TOR usecase this address will be used as default gateway for Host behind the TOR.	False	None	CRUD	user
:ref:virtual-router virtual-router-label	Reference to virtual router of this instance ip.	False	None	CRUD	user
:ref:logical-interface logical-interface-label	Reference to the logical interface that this instance ip is assigned to.	False	None	CRUD	user
:ref:flow-node flow-node-label	Reference to the flow node that this instance ip is assigned to.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:service-instance service-instance-label

REST API

Fetch a specific instance-ip

GET /instance-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	InstanceIpReadAll
404	Not Found	Error

Update a specific instance-ip

PUT /instance-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	instance-ip optional		InstanceIpUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific instance-ip

DELETE /instance-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of instance-ip

GET /instance-ips

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new instance-ip

POST /instance-ips

Parameters

Type	Name	Description	Schema	Default
body	instance-ip required	Body of instance-ip resource	InstanceIpCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

intent-map

Data Model

Description

List of intent-maps in the system.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
intent-map-intent-type	Based on this value we determine what intent model we are serving	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:physical-router physical-router-label, :ref:fabric fabric-label, :ref:virtual-network virtual-network-label

REST API

Fetch a specific intent-map

GET /intent-map/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	IntentMapReadAll
404	Not Found	Error

Update a specific intent-map

PUT /intent-map/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	intent-map optional		IntentMapUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific intent-map

DELETE /intent-map/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of intent-map

GET /intent-maps

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new intent-map

POST /intent-maps

Parameters

Type	Name	Description	Schema	Default
body	intent-map required	Body of intent-map resource	IntentMapCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

interface-route-table

Data Model

Description

Interface route table is mechanism to add static routes pointing to this interface.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
interface-route-table-routes	Interface route table used same structure as route table, however the next hop field is irrelevant.	True	RouteTableType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-instance service-instance-label	Reference to interface route table attached to (service instance, interface), This is used to add interface static routes to service instance interface.	False	ServiceInterfaceTag	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:virtual-machine-interface virtual-machine-interface-label, :ref:routing-policy routing-policy-label

REST API

Fetch a specific interface-route-table

GET /interface-route-table/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	InterfaceRouteTableReadAll
404	Not Found	Error

Update a specific interface-route-table

PUT /interface-route-table/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	interface-route-table optional		InterfaceRouteTableUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific interface-route-table

DELETE /interface-route-table/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of interface-route-table

GET /interface-route-tables

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new interface-route-table

POST /interface-route-tables

Parameters

Type	Name	Description	Schema	Default
body	interface-route-table required	Body of interface-route-table resource	InterfaceRouteTableCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

job-template

Data Model

Description

List of job templates supported by the system.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
job-template-synchronous-job	if set to true, the ‘/execute-job’ action simply executes the playbook directly and wait until the playbook finishes. So the playbook in the synchronous job should not take long to execute. There will no job log or job uve being created for synchronous job. This is an optional field. If not set, the default value is ‘false’.	True	boolean	CRUD	user
job-template-type	This attribute is to identify the template type. This property is mainly needed to list all generic device operations in the UI. There are at present 4 types. Workflow based (e.g. fabric onboarding, existing fabric onboarding), device operation based (standalone like e.g. device discovery, device import, discover role), config based (e.g. role_assignment, fabric_config) and device command based (for generic device operations)	True	string	CRUD	user
job-template-concurrency-level	This attribute controls the number concurrent job execution against the same fabric. When this attribute set to ‘fabric’, there could only one job execution per fabric When this attribute set to ‘device’, there could be only one playbook execution running against the same device at the time.	True	string	CRUD	user
job-template-playbooks	List of vendor specific playbooks that achieve the same functionality on each vendor device. All the vendor specific playbooks listed here share the same input/output schema defined in the job template	True	PlaybookInfoListType	CRUD	user
job-template-recovery-playbooks	List of vendor specific playbooks that can be used to recover from an error in the workflow. All the vendor specific playbooks listed here share the same input/output schema defined in the job template	False	PlaybookInfoListType	CRUD	user
job-template-executables	List of Executables that needs to be Executed	False	ExecutableInfoListType	CRUD	user
job-template-input-schema	JSON schema of the job input parameters which will be used to validate the job input json or generate UI form for user to enter the job parameters. This property stores the JSON schema content as string. Here is an example fo the image upgrade job template input schema:{ ‘$schema’: ‘http ://json-schema.org/draft-06/schema#’, ‘title’: ‘Image upgrade input’, ‘type’: ‘object’, ‘properties’: { ‘image_uuid’: { ‘type’: ‘string’ } }, ‘required’: [‘image_uuid’]}	False	string	CRUD	user
job-template-output-schema	JSON schema of the job output that describes the output from the job and could be used by UI to render the output automatically. This property stores the JSON schema content as string.	False	string	CRUD	user
job-template-input-ui-schema	UI JSON schema of the job input that could be used by UI to render the input form with certain nice- to-have features like ordering of the input fields, placeholders etc. This property stores the UI JSON schema content as string.	False	string	CRUD	user
job-template-output-ui-schema	UI JSON schema of the job output that could be used by UI to render the input form with certain nice-to-have features like ordering of the output fields etc. This property stores the UI JSON schema content as string.	False	string	CRUD	user
job-template-description	A detailed description of what the job template functionality is	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:node-profile node-profile-label

REST API

Fetch a specific job-template

GET /job-template/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	JobTemplateReadAll
404	Not Found	Error

Update a specific job-template

PUT /job-template/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	job-template optional		JobTemplateUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific job-template

DELETE /job-template/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of job-template

GET /job-templates

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new job-template

POST /job-templates

Parameters

Type	Name	Description	Schema	Default
body	job-template required	Body of job-template resource	JobTemplateCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

link-aggregation-group

Data Model

Description

List of link aggregation groups on this PRouter.

Parents: physical-router

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
link-aggregation-group-lacp-enabled	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	True	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:physical-interface physical-interface-label	All the interfaces that belongs to the LAG. There should be exact one ref edge that points to the lag interface and two or more ref-edges points to the regular interfaces.	False	None	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	list of virtual machine interfaces connected to this link aggregation group	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific link-aggregation-group

GET /link-aggregation-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LinkAggregationGroupReadAll
404	Not Found	Error

Update a specific link-aggregation-group

PUT /link-aggregation-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	link-aggregation-group optional		LinkAggregationGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific link-aggregation-group

DELETE /link-aggregation-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of link-aggregation-group

GET /link-aggregation-groups

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new link-aggregation-group

POST /link-aggregation-groups

Parameters

Type	Name	Description	Schema	Default
body	link-aggregation-group required	Body of link-aggregation-group resource	LinkAggregationGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

loadbalancer

Data Model

Description

Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners, pools). Applicable to LBaaS V2.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
loadbalancer-properties	Loadbalancer configuration like admin state, VIP, VIP subnet etc.	True	LoadbalancerType	CRUD	user
loadbalancer-provider	Provider field selects backend provider of the LBaaS, Cloudadmin could offer different levels of service like gold, silver, bronze. Provided by HA-proxy or various HW or SW appliances in the backend.	False	string	CR	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-appliance-set service-appliance-set-label		False	None	CRUD	user
:ref:service-instance service-instance-label	Reference to the service instance, created automatically by the system.	False	None	CRUD	system
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to the virtual machine interface for VIP, created automatically by the system.	False	None	CRUD	system
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:loadbalancer-listener loadbalancer-listener-label

REST API

Fetch a specific loadbalancer

GET /loadbalancer/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerReadAll
404	Not Found	Error

Update a specific loadbalancer

PUT /loadbalancer/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer optional		LoadbalancerUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer

DELETE /loadbalancer/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer

GET /loadbalancers

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer

POST /loadbalancers

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer required	Body of loadbalancer resource	LoadbalancerCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific loadbalancer-healthmonitor

GET /loadbalancer-healthmonitor/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerHealthmonitorReadAll
404	Not Found	Error

Update a specific loadbalancer-healthmonitor

PUT /loadbalancer-healthmonitor/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-healthmonitor optional		LoadbalancerHealthmonitorUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-healthmonitor

DELETE /loadbalancer-healthmonitor/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-healthmonitor

GET /loadbalancer-healthmonitors

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-healthmonitor

POST /loadbalancer-healthmonitors

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-healthmonitor required	Body of loadbalancer-healthmonitor resource	LoadbalancerHealthmonitorCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific loadbalancer-listener

GET /loadbalancer-listener/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerListenerReadAll
404	Not Found	Error

Update a specific loadbalancer-listener

PUT /loadbalancer-listener/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-listener optional		LoadbalancerListenerUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-listener

DELETE /loadbalancer-listener/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-listener

GET /loadbalancer-listeners

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-listener

POST /loadbalancer-listeners

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-listener required	Body of loadbalancer-listener resource	LoadbalancerListenerCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific loadbalancer-member

GET /loadbalancer-member/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerMemberReadAll
404	Not Found	Error

Update a specific loadbalancer-member

PUT /loadbalancer-member/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-member optional		LoadbalancerMemberUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-member

DELETE /loadbalancer-member/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-member

GET /loadbalancer-members

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-member

POST /loadbalancer-members

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-member required	Body of loadbalancer-member resource	LoadbalancerMemberCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific loadbalancer-pool

GET /loadbalancer-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerPoolReadAll
404	Not Found	Error

Update a specific loadbalancer-pool

PUT /loadbalancer-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-pool optional		LoadbalancerPoolUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-pool

DELETE /loadbalancer-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-pool

GET /loadbalancer-pools

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-pool

POST /loadbalancer-pools

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-pool required	Body of loadbalancer-pool resource	LoadbalancerPoolCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

loadbalancer-healthmonitor

Data Model

Description

Health monitor objects is configuration to monitor health of individual pool members.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
loadbalancer-healthmonitor-properties	Configuration parameters for health monitor like type, method, retries etc.	True	LoadbalancerHealthmonitorType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:loadbalancer-pool loadbalancer-pool-label

REST API

Fetch a specific loadbalancer-healthmonitor

GET /loadbalancer-healthmonitor/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerHealthmonitorReadAll
404	Not Found	Error

Update a specific loadbalancer-healthmonitor

PUT /loadbalancer-healthmonitor/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-healthmonitor optional		LoadbalancerHealthmonitorUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-healthmonitor

DELETE /loadbalancer-healthmonitor/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-healthmonitor

GET /loadbalancer-healthmonitors

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-healthmonitor

POST /loadbalancer-healthmonitors

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-healthmonitor required	Body of loadbalancer-healthmonitor resource	LoadbalancerHealthmonitorCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

loadbalancer-listener

Data Model

Description

Listener represents the application(protocol, port) to be load balanced.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
loadbalancer-listener-properties	None	False	LoadbalancerListenerType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:loadbalancer loadbalancer-label		False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:loadbalancer-pool loadbalancer-pool-label

REST API

Fetch a specific loadbalancer-listener

GET /loadbalancer-listener/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerListenerReadAll
404	Not Found	Error

Update a specific loadbalancer-listener

PUT /loadbalancer-listener/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-listener optional		LoadbalancerListenerUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-listener

DELETE /loadbalancer-listener/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-listener

GET /loadbalancer-listeners

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-listener

POST /loadbalancer-listeners

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-listener required	Body of loadbalancer-listener resource	LoadbalancerListenerCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

loadbalancer-member

Data Model

Description

Configuration object representing each member of load balancer pool.

Parents: loadbalancer-pool

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
loadbalancer-member-properties	Member configuration like ip address, destination port, weight etc.	True	LoadbalancerMemberType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

None

REST API

Fetch a specific loadbalancer-member

GET /loadbalancer-member/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerMemberReadAll
404	Not Found	Error

Update a specific loadbalancer-member

PUT /loadbalancer-member/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-member optional		LoadbalancerMemberUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-member

DELETE /loadbalancer-member/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-member

GET /loadbalancer-members

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-member

POST /loadbalancer-members

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-member required	Body of loadbalancer-member resource	LoadbalancerMemberCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

loadbalancer-pool

Data Model

Description

Loadbalancer pool object represent set(pool) member servers which needs load balancing.

Parents: project

Children

loadbalancer-member

Properties

Name	Description	Required	Type	Operations	Created By
loadbalancer-pool-properties	Configuration for loadbalancer pool like protocol, subnet, etc.	True	LoadbalancerPoolType	CRUD	user
loadbalancer-pool-provider	Provider field selects backend provider of the LBaaS, Cloudadmin could offer different levels of service like gold, silver, bronze. Provided by HA-proxy or various HW or SW appliances in the backend. Applicable to LBaaS V1	False	string	CR	user
loadbalancer-pool-custom-attributes	Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable to LBaaS V1.	False	KeyValuePairs	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-instance service-instance-label	Reference to the service instance serving this pool, applicable to LBaaS V1.	False	None	CR	system
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to the virtual machine interface reaching pool subnet, applicable to LBaaS V1.	False	None	CR	system
:ref:loadbalancer-listener loadbalancer-listener-label	Reference to loadbalancer listener served by this pool, applicable to LBaaS V2.	False	None	CRUD	user
:ref:service-appliance-set service-appliance-set-label		False	None	RReference to service-appliance-set where this loadbalancer-pool is hosted. Applicable to LBaaS V1.	system
:ref:loadbalancer-healthmonitor loadbalancer-healthmonitor-label	Reference to loadbalancer healthmonitor that this pool uses.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:virtual-ip virtual-ip-label

REST API

Fetch a specific loadbalancer-pool

GET /loadbalancer-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LoadbalancerPoolReadAll
404	Not Found	Error

Update a specific loadbalancer-pool

PUT /loadbalancer-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	loadbalancer-pool optional		LoadbalancerPoolUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific loadbalancer-pool

DELETE /loadbalancer-pool/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of loadbalancer-pool

GET /loadbalancer-pools

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new loadbalancer-pool

POST /loadbalancer-pools

Parameters

Type	Name	Description	Schema	Default
body	loadbalancer-pool required	Body of loadbalancer-pool resource	LoadbalancerPoolCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

logical-interface

Data Model

Description

When parent is physical-router,

Logical interfaces on physical routers.

When parent is physical-interface,

Logical interfaces on physical interface on physical routers.

Parents: physical-router, physical-interface

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
logical-interface-vlan-tag	VLAN tag (.1Q) classifier for this logical interface.	False	number	CRUD	user
logical-interface-port-params	User can select this option to configure port parameters such as description, MTU and port enable or disable.	False	PortParameters	CRUD	user
logical-interface-type	Logical interface type can be L2 or L3. L2 - only L2 service is provided, MAC learning is supported. L3 - only L3 service is supported and MAC learning is not supported.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-machine-interface virtual-machine-interface-label	References to virtual machine interfaces that represent end points that are reachable by this logical interface.	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:instance-ip instance-ip-label

REST API

Fetch a specific logical-interface

GET /logical-interface/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LogicalInterfaceReadAll
404	Not Found	Error

Update a specific logical-interface

PUT /logical-interface/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	logical-interface optional		LogicalInterfaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific logical-interface

DELETE /logical-interface/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of logical-interface

GET /logical-interfaces

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new logical-interface

POST /logical-interfaces

Parameters

Type	Name	Description	Schema	Default
body	logical-interface required	Body of logical-interface resource	LogicalInterfaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

logical-router

Data Model

Description

Logical router is a mechanism to connect multiple virtual network as they have been connected by a router.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
configured-route-target-list	List of route targets that represent this logical router, all virtual networks connected to this logical router will have this as their route target list.	False	RouteTargetList	CRUD	user
vxlan-network-identifier	The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.	False	string	CRUD	user
logical-router-dhcp-relay-server	DHCP server IP(s) to serve managed BMS(s).	False	IpAddressesType	CRUD	user
logical-router-gateway-external	this logical router is used for external connectivity or not.	True	boolean	CRUD	user
logical-router-type	Type of logical-router, used to signify the purpose of the logical-router.	False	string	CRD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to the interface attached to this logical router. By attaching a interface to logical network all subnets in the virtual network of the interface has this router.	False	None	CRUD	user
:ref:route-target route-target-label	Route target that represent this logical router.	False	None	CRUD	system
:ref:route-table route-table-label	Reference to the route table attached to this logical router. By attaching route table, system will create static routes with the route target only of route targets linked to this logical router	False	None	CRUD	user
:ref:virtual-network virtual-network-label	Reference to a virtual network. Please refer to link attribute for additional details	False	LogicalRouterVirtualNetworkType	CRUD	user
:ref:service-instance service-instance-label	Reference to service instance doing SNAT functionality for external gateway.	False	None	CRUD	system
:ref:physical-router physical-router-label	Reference to physical router, when this link is present device manager configures logical router associated route targets/interfaces on the Physical Router.	False	None	CRUD	user
:ref:fabric fabric-label	Reference to fabric, this link enables to identify which fabric, the device this LR belongs to is on.	False	None	CRUD	user
:ref:bgpvpn bgpvpn-label	Back reference to logical router associated to the BGP VPN resource	False	None	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:port-tuple port-tuple-label, :ref:data-center-interconnect data-center-interconnect-label

REST API

Fetch a specific logical-router

GET /logical-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	LogicalRouterReadAll
404	Not Found	Error

Update a specific logical-router

PUT /logical-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	logical-router optional		LogicalRouterUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific logical-router

DELETE /logical-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of logical-router

GET /logical-routers

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new logical-router

POST /logical-routers

Parameters

Type	Name	Description	Schema	Default
body	logical-router required	Body of logical-router resource	LogicalRouterCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

multicast-policy

Data Model

Description

List of references of child multicast policy objects. automatically maintained by system.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
multicast-source-groups	List of Multicast (S,G) Addresses.	False	MulticastSourceGroups	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:virtual-network virtual-network-label

REST API

Fetch a specific multicast-policy

GET /multicast-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	MulticastPolicyReadAll
404	Not Found	Error

Update a specific multicast-policy

PUT /multicast-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	multicast-policy optional		MulticastPolicyUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific multicast-policy

DELETE /multicast-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of multicast-policy

GET /multicast-policys

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False
query	fields optional	CSV List of specific fields to report	string	fq_name	uuid	href
query	filters optional	CSV List of <property field>==<value> to match for reported collection.	string
query	count optional	Only report count of resource collection matching anchor criteria	boolean	False
query	exclude_hrefs optional	Omit reporting href field in collection report	string
query	shared optional	Include globally shared resources in collection report	boolean
query	parent_type optional	This along with parent_fq_name_str can be used as anchor for collection report	string
query	parent_fq_name_str optional	This along with parent_type can be used as anchor for collection report	string
query	parent_id optional	List of csv parent uuids that form anchor for collection report	string
query	back_ref_id optional	List of csv backref uuids that form anchor for collection report	string
query	obj_uuids optional	List of object uuids for collection report	string

Responses

HTTP Code	Description	Schema
200	Success	ResourceListSummary

Create a new multicast-policy

POST /multicast-policys

Parameters

Type	Name	Description	Schema	Default
body	multicast-policy required	Body of multicast-policy resource	MulticastPolicyCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

namespace

Data Model

Description

Namespace is unique networking namespace within this domain. If namespace is not present then default namespace of default project is used.

Parents: domain

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
namespace-cidr	All networks in this namespace belong to this list of Prefixes. Not implemented.	False	SubnetType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:project project-label

REST API

Fetch a specific fabric-namespace

GET /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
query	fields optional	If specified, backref and children fields to be returned (properties and refs always returned)	string
query	exclude_back_refs optional	If specified, backref fields will not be returned	string
query	exclude_children optional	If specified, children fields will not be returned	string
query	exclude_hrefs optional	Omit reporting href field for children/refs/backrefs.	string

Responses

HTTP Code	Description	Schema
200	Success	FabricNamespaceReadAll
404	Not Found	Error

Update a specific fabric-namespace

PUT /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	fabric-namespace optional		FabricNamespaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific fabric-namespace

DELETE /fabric-namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error
409	Conflict	Error

List collection of fabric-namespace

GET /fabric-namespaces

Parameters

Type	Name	Description	Schema	Default
query	detail optional	Report all property and reference fields of resource	boolean	False		&