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
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

Fetch a specific namespace

GET /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	NamespaceReadAll
404	Not Found	Error

Update a specific namespace

PUT /namespace/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	namespace optional		NamespaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific namespace

DELETE /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 namespace

GET /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 namespace

POST /namespaces

Parameters

Type	Name	Description	Schema	Default
body	namespace required	Body of namespace resource	NamespaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

netconf-profile

Data Model

Description

This resource contains information specific to netconf parameters

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
netconf-profile-is-default	This attribute indicates whether it is a default netconf profile or not. Default profiles are non- editable.	False	boolean	CRUD	user
netconf-parameters	Parameters for each netconf profile like the top level sensor options etc.	False	NetconfParameters	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 netconf-profile

GET /netconf-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	NetconfProfileReadAll
404	Not Found	Error

Update a specific netconf-profile

PUT /netconf-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	netconf-profile optional		NetconfProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific netconf-profile

DELETE /netconf-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 netconf-profile

GET /netconf-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 netconf-profile

POST /netconf-profiles

Parameters

Type	Name	Description	Schema	Default
body	netconf-profile required	Body of netconf-profile resource	NetconfProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

network-device-config

Data Model

Description

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:physical-router physical-router-label	Network device config of a physical router.	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 network-device-config

GET /network-device-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	NetworkDeviceConfigReadAll
404	Not Found	Error

Update a specific network-device-config

PUT /network-device-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	network-device-config optional		NetworkDeviceConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific network-device-config

DELETE /network-device-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 network-device-config

GET /network-device-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 network-device-config

POST /network-device-configs

Parameters

Type	Name	Description	Schema	Default
body	network-device-config required	Body of network-device-config resource	NetworkDeviceConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

network-ipam

Data Model

Description

IP Address Management object that controls, ip allocation, DNS and DHCP

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
network-ipam-mgmt	Network IP Address Management configuration.	False	IpamType	CRUD	user
ipam-subnets	List of subnets for this ipam.	False	IpamSubnets	CRD	user
ipam-subnet-method	Subnet method configuration for ipam, user can configure user-defined, flat or auto.	False	string	CRD	user
ipam-subnetting	This flag indicates if ipam subnets are carved out from a big subnet, default behavior is False.	False	boolean	CRD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-DNS virtual-DNS-label	Reference to virtual DNS used by this IPAM.	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, :ref:virtual-router virtual-router-label, :ref:virtual-network virtual-network-label

REST API

Fetch a specific network-ipam

GET /network-ipam/{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	NetworkIpamReadAll
404	Not Found	Error

Update a specific network-ipam

PUT /network-ipam/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	network-ipam optional		NetworkIpamUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific network-ipam

DELETE /network-ipam/{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 network-ipam

GET /network-ipams

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 network-ipam

POST /network-ipams

Parameters

Type	Name	Description	Schema	Default
body	network-ipam required	Body of network-ipam resource	NetworkIpamCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

network-policy

Data Model

Description

Network Policy is set access control rules that can be attached to virtual networks. Network ACL(s) and connectivity information is derived from Network policies that are attached to virtual networks.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
network-policy-entries	Network policy rule entries.	True	PolicyEntriesType	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:security-logging-object security-logging-object-label, :ref:virtual-network virtual-network-label

REST API

Fetch a specific network-policy

GET /network-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	NetworkPolicyReadAll
404	Not Found	Error

Update a specific network-policy

PUT /network-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	network-policy optional		NetworkPolicyUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific network-policy

DELETE /network-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 network-policy

GET /network-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 network-policy

POST /network-policys

Parameters

Type	Name	Description	Schema	Default
body	network-policy required	Body of network-policy resource	NetworkPolicyCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

node

Data Model

Description

Parent of this node resource.

Parents: global-system-config

Children

port, port-group

Properties

Name	Description	Required	Type	Operations	Created By
node_type	Type of machine resource	False	string	CRUD	user
esxi-info	Details of the ESXI host	False	ESXIHostInfo	CRUD	user
ip-address	IP Address of the Management interface	False	string	CRUD	user
hostname	Fully qualified host name	False	string	CRUD	user
bms-info	Details of the baremetal server	False	BaremetalServerInfo	CRUD	user
mac-address	Provisioning Interface MAC Address	False	string	CRUD	user
disk-partition	Comma seperated disk partition to use.	False	string	CRUD	user
interface-name	Name of the Management interface	False	string	CRUD	user
cloud-info	Information related to cloud	False	CloudInstanceInfo	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:node-profile node-profile-label	Reference to matching node-profile object for this node	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 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

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

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

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 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

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

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

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

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

Fetch a specific node

GET /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	NodeReadAll
404	Not Found	Error

Update a specific node

PUT /node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	node optional		NodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific node

DELETE /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 node

GET /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 node

POST /nodes

Parameters

Type	Name	Description	Schema	Default
body	node required	Body of node resource	NodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific node-profile

GET /node-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	NodeProfileReadAll
404	Not Found	Error

Update a specific node-profile

PUT /node-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	node-profile optional		NodeProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific node-profile

DELETE /node-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 node-profile

GET /node-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 node-profile

POST /node-profiles

Parameters

Type	Name	Description	Schema	Default
body	node-profile required	Body of node-profile resource	NodeProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific webui-node

GET /webui-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	WebuiNodeReadAll
404	Not Found	Error

Update a specific webui-node

PUT /webui-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	webui-node optional		WebuiNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific webui-node

DELETE /webui-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 webui-node

GET /webui-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 webui-node

POST /webui-nodes

Parameters

Type	Name	Description	Schema	Default
body	webui-node required	Body of webui-node resource	WebuiNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

node-profile

Data Model

Description

Node profile contains the meta-data to profile/categorize the devices so that a list of supported capabilities/roles by the device are known to the system. For example, we can define a node profile to specify list of capabilities/roles supported by a set of QFX10K devices with certain hardware/software installed. It also contains the default config parameter values for each supported roles/capability. These are the config parameters that are not modeled in the VNC data model. They could be vendor specific config parameters that we allow user to tweak via API or some kind of auto generated UI from job template input schema. The UML diagram for node-profile can be found at https://github.com/jnpr-tjiang/cfm-data-model/blob/master/5.0.1-data-model/images/node_profile.png

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
node-profile-type	Node profile type to differentiate the node profile network devices from server node profiles.	False	string	CRUD	user
node-profile-vendor	Vendor name (e.g. Juniper) that this node profile can be used for.	True	string	CRUD	user
node-profile-device-family	Device family name that this node profile can be used to match.	True	string	CRUD	user
node-profile-hitless-upgrade	if set to false, do not perform hitless image upgrade on devices using this node profile	True	boolean	CRUD	user
node-profile-roles	List of capable physical and routing-bridging role combinations supported by the devices that matches one of the hardware list defined in this node profile.	True	NodeProfileRolesType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:job-template job-template-label	This reference associates the node profile to a job-template that contains a playbook that generates device specific role config and deploys it to the device. The role-config.config attribtue value must be in JSON format and conform to the input_schema defined in the job-template.	False	None	CRUD	user
:ref:hardware hardware-label	Hardware info defined in a node profile that are used to categorize the devices	False	None	CRUD	user
:ref:role-definition role-definition-label	list of role definitions supported for this node profile	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 node-label, :ref:physical-router physical-router-label, :ref:fabric fabric-label

REST API

Fetch a specific node-profile

GET /node-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	NodeProfileReadAll
404	Not Found	Error

Update a specific node-profile

PUT /node-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	node-profile optional		NodeProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific node-profile

DELETE /node-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 node-profile

GET /node-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 node-profile

POST /node-profiles

Parameters

Type	Name	Description	Schema	Default
body	node-profile required	Body of node-profile resource	NodeProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

overlay-role

Data Model

Description

Defines an overlay role

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

:ref:physical-router physical-router-label, :ref:role-definition role-definition-label

REST API

Fetch a specific overlay-role

GET /overlay-role/{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	OverlayRoleReadAll
404	Not Found	Error

Update a specific overlay-role

PUT /overlay-role/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	overlay-role optional		OverlayRoleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific overlay-role

DELETE /overlay-role/{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 overlay-role

GET /overlay-roles

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 overlay-role

POST /overlay-roles

Parameters

Type	Name	Description	Schema	Default
body	overlay-role required	Body of overlay-role resource	OverlayRoleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

peering-policy

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
peering-service	Peering policy service type.	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

:ref:e2-service-provider e2-service-provider-label

REST API

Fetch a specific peering-policy

GET /peering-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	PeeringPolicyReadAll
404	Not Found	Error

Update a specific peering-policy

PUT /peering-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	peering-policy optional		PeeringPolicyUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific peering-policy

DELETE /peering-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 peering-policy

GET /peering-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 peering-policy

POST /peering-policys

Parameters

Type	Name	Description	Schema	Default
body	peering-policy required	Body of peering-policy resource	PeeringPolicyCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

physical-interface

Data Model

Description

Physical interfaces on physical routers.

Parents: physical-router

Children

logical-interface

Properties

Name	Description	Required	Type	Operations	Created By
ethernet-segment-identifier	Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should configure the peer Physical interface with the same ESI.	False	string	CRUD	user
physical-interface-type	Physical interface type that can be either regular/LAG/service/fabric/access link.	False	string	CRUD	user
physical-interface-mac-addresses	MAC addresses on this physical interface.	False	MacAddressesType	CRUD	user
physical-interface-port-id	port id of this physical interface. This port id is used in LLDP to identify a physical port on the peering device	False	string	CRUD	user
physical-interface-flow-control	User can enable this option to configure flow control on the physical interface.	False	boolean	CRUD	user
physical-interface-lacp-force-up	User can enable this option to make LACP up and running. This is applicable only on individual member physical interfaces of a VPG.	False	boolean	CRUD	user
physical-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

References

To	Description	Required	Type	Operations	Created By
:ref:physical-interface physical-interface-label	Reference to the other physical interface that is connected to this physical interface.	False	None	CRUD	user
:ref:port port-label	This link represents physical connection from access port of a switch to the server port	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:link-aggregation-group link-aggregation-group-label, :ref:virtual-machine-interface virtual-machine-interface-label, :ref:virtual-port-group virtual-port-group-label, :ref:service-appliance service-appliance-label

REST API

Fetch a specific physical-interface

GET /physical-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	PhysicalInterfaceReadAll
404	Not Found	Error

Update a specific physical-interface

PUT /physical-interface/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	physical-interface optional		PhysicalInterfaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific physical-interface

DELETE /physical-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 physical-interface

GET /physical-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 physical-interface

POST /physical-interfaces

Parameters

Type	Name	Description	Schema	Default
body	physical-interface required	Body of physical-interface resource	PhysicalInterfaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

physical-role

Data Model

Description

Defines a physical role

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

:ref:physical-router physical-router-label, :ref:device-functional-group device-functional-group-label, :ref:role-definition role-definition-label

REST API

Fetch a specific physical-role

GET /physical-role/{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	PhysicalRoleReadAll
404	Not Found	Error

Update a specific physical-role

PUT /physical-role/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	physical-role optional		PhysicalRoleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific physical-role

DELETE /physical-role/{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 physical-role

GET /physical-roles

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 physical-role

POST /physical-roles

Parameters

Type	Name	Description	Schema	Default
body	physical-role required	Body of physical-role resource	PhysicalRoleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

physical-router

Data Model

Description

Physical router object represent any physical device that participates in virtual networking, like routers, switches, servers, firewalls etc.

Parents: global-system-config

Children

cli-config, hardware-inventory, link-aggregation-group, logical-interface, physical-interface

Properties

Name	Description	Required	Type	Operations	Created By
physical-router-junos-service-ports	Juniper JUNOS specific service interfaces name to perform services like NAT.	False	JunosServicePorts	CRUD	user
telemetry-info	Telemetry info of router. Check TelemetryStateInfo	False	TelemetryStateInfo	CRUD	user
physical-router-device-family	Device family that this physical router is part of. It is used by the device manager to choose the device family specific Ansible playbooks for device management	True	string	CRUD	user
physical-router-os-version	os version for this physical router. It is updated when device is imported or device image is successfully upgraded	False	string	CRUD	user
physical-router-hostname	Device host name that can be either discovered during via fabric on-boarding workflow or manually set by the user	False	string	CRUD	user
physical-router-management-ip	Management ip for this physical router. It is used by the device manager to perform netconf and by SNMP collector if enabled.	True	string	CRUD	user
physical-router-management-mac	Management mac for this physical router.	False	string	CRUD	user
physical-router-dataplane-ip	This is ip address in the ip-fabric(underlay) network that can be used in data plane by physical router. Usually it is the VTEP address in VxLAN for the TOR switch.	False	string	CRUD	user
physical-router-loopback-ip	This is ip address of loopback interface of physical router. Used by the device manager to configure physical router loopback interface.	False	string	CRUD	user
physical-router-replicator-loopback-ip	This is the loopback ip address for assisted replication. Used by the device manager to configure physical router replicator ip.	False	string	CRUD	user
physical-router-vendor-name	Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.	True	string	CRUD	user
physical-router-product-name	Model name of the physical router (e.g juniper). Used by the device manager to select driver.	True	string	CRUD	user
physical-router-serial-number	Serial number for the physical device that is used by device manager to identify the device during device discovery.	False	string	CRUD	user
physical-router-vnc-managed	This physical router is enabled to be configured by device manager.	False	boolean	CRUD	user
physical-router-underlay-managed	Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this attribute to true. The brownfield on-boarding sets this attribute to false.	False	boolean	CRUD	user
physical-router-role	Physical router role (e.g spine or leaf), 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	string	CRUD	user
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
physical-router-snmp	SNMP support on this router	False	boolean	CRUD	user
physical-router-lldp	LLDP support on this router	False	boolean	CRUD	user
physical-router-user-credentials	Username and password for netconf to the physical router by device manager.	False	UserCredentials	CRUD	user
physical-router-encryption-type	Type of encryption used for physical-router-user-credentials.	False	string	CRUD	user
physical-router-snmp-credentials	SNMP credentials for the physical router used by SNMP collector.	False	SNMPCredentials	CRUD	user
physical-router-dhcp-parameters	Dnsmasq lease parameters for the physical router.	False	DnsmasqLeaseParameters	CRUD	user
physical-router-cli-commit-state	CLI commit state for the physical router. Used to check if device is in sync with Contrail managed configs	False	string	CRUD	user
physical-router-managed-state	Managed state for the physical router. Used to RMA devices	False	string	CRUD	user
physical-router-onboarding-state	Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the device such as discovered, interface onboarded, topology discovered, underlay configured and others	False	string	CRUD	user
physical-router-underlay-config	Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical- router-underlay-managed is false	False	string	CRUD	user
physical-router-supplemental-config	Supplemental configuration stored during ZTP onboarding.	False	string	CRUD	user
physical-router-autonomous-system	Autonomous system configured on the device represented by the physical router.	False	AutonomousSystemsType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-router virtual-router-label	Reference to vrouter responsible for this physical router. Currently only applicable for vrouters that are TOR agents.	False	None	CRUD	user
:ref:bgp-router bgp-router-label	Reference to BGP peer representing this physical router.	False	None	CRUD	user
:ref:virtual-network virtual-network-label	Reference to virtual network, whose VRF is present on this physical router, Applicable when only VRF is present with no physical interfaces from this physical vrouter. Generally used when using device manager and option A+B for this virtual network in L3VPN use case.	False	None	CRUD	user
:ref:intent-map intent-map-label	The Physical Routers on which the config needs to be pushed	False	None	CRUD	user
:ref:fabric fabric-label	Fabric that this physical-router belongs to.	False	None	CRUD	user
:ref:node-profile node-profile-label	Node profile assigned to the physical router during device discovery/onboarding.	False	None	CRUD	user
:ref:device-functional-group device-functional-group-label	Device functional group that this physical-router belongs to.	False	None	CRUD	user
:ref:device-chassis device-chassis-label	Device Chassis info assigned to the physical router during device discovery/onboarding.	False	None	CRUD	user
:ref:device-image device-image-label	Intended device image for this PRouter. Each PRouter can have one and only one device image assigned. If this image is successfully installed on the PRouter, the PRouterUVE.os_version should match the os-version property of the image	False	None	CRUD	user
:ref:physical-role physical-role-label	Physical role assigned to this physical router	False	None	CRUD	user
:ref:overlay-role overlay-role-label	Overlay roles assigned to this physical router	False	None	CRUD	user
:ref:telemetry-profile telemetry-profile-label	Telemetry profile assigned to the physical router by user. Each physical router is associated with only one telemetry profile.	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, :ref:e2-service-provider e2-service-provider-label, :ref:network-device-config network-device-config-label, :ref:service-endpoint service-endpoint-label, :ref:logical-router logical-router-label

REST API

Fetch a specific physical-router

GET /physical-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	PhysicalRouterReadAll
404	Not Found	Error

Update a specific physical-router

PUT /physical-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	physical-router optional		PhysicalRouterUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific physical-router

DELETE /physical-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 physical-router

GET /physical-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 physical-router

POST /physical-routers

Parameters

Type	Name	Description	Schema	Default
body	physical-router required	Body of physical-router resource	PhysicalRouterCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

policy-management

Data Model

Description

When parent is project,

Project level policy-management object re-grouping project policy resources

Parents: project

Children

address-group, application-policy-set, firewall-policy, firewall-rule, service-group

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 policy-management

GET /policy-management/{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	PolicyManagementReadAll
404	Not Found	Error

Update a specific policy-management

PUT /policy-management/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	policy-management optional		PolicyManagementUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific policy-management

DELETE /policy-management/{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 policy-management

GET /policy-managements

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 policy-management

POST /policy-managements

Parameters

Type	Name	Description	Schema	Default
body	policy-management required	Body of policy-management resource	PolicyManagementCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

port

Data Model

Description

Parent of this port.

Parents: node

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
port-group-uuid	UUID of the port group in which this port belongs	False	string	CRUD	user
bms-port-info	Details of the baremetal server port	False	BaremetalPortInfo	CRUD	user
esxi-port-info	Information related to Port-ESXi/vCenter	False	ESXIProperties	CRUD	user
label	Label of the interface representing the use of the interface.	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-interface physical-interface-label, :ref:port-group port-group-label

REST API

Fetch a specific port

GET /port/{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	PortReadAll
404	Not Found	Error

Update a specific port

PUT /port/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port optional		PortUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port

DELETE /port/{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 port

GET /ports

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 port

POST /ports

Parameters

Type	Name	Description	Schema	Default
body	port required	Body of port resource	PortCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific port-group

GET /port-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	PortGroupReadAll
404	Not Found	Error

Update a specific port-group

PUT /port-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port-group optional		PortGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port-group

DELETE /port-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 port-group

GET /port-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 port-group

POST /port-groups

Parameters

Type	Name	Description	Schema	Default
body	port-group required	Body of port-group resource	PortGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific port-profile

GET /port-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	PortProfileReadAll
404	Not Found	Error

Update a specific port-profile

PUT /port-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port-profile optional		PortProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port-profile

DELETE /port-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 port-profile

GET /port-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 port-profile

POST /port-profiles

Parameters

Type	Name	Description	Schema	Default
body	port-profile required	Body of port-profile resource	PortProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific port-tuple

GET /port-tuple/{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	PortTupleReadAll
404	Not Found	Error

Update a specific port-tuple

PUT /port-tuple/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port-tuple optional		PortTupleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port-tuple

DELETE /port-tuple/{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 port-tuple

GET /port-tuples

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 port-tuple

POST /port-tuples

Parameters

Type	Name	Description	Schema	Default
body	port-tuple required	Body of port-tuple resource	PortTupleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific virtual-port-group

GET /virtual-port-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	VirtualPortGroupReadAll
404	Not Found	Error

Update a specific virtual-port-group

PUT /virtual-port-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-port-group optional		VirtualPortGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-port-group

DELETE /virtual-port-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 virtual-port-group

GET /virtual-port-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 virtual-port-group

POST /virtual-port-groups

Parameters

Type	Name	Description	Schema	Default
body	virtual-port-group required	Body of virtual-port-group resource	VirtualPortGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

port-group

Data Model

Description

Parent of this port group.

Parents: node

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
bms-port-group-info	Details of the baremetal server port group	False	BaremetalPortGroupInfo	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:port port-label	Reference to port object which are part of this port 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 port-group

GET /port-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	PortGroupReadAll
404	Not Found	Error

Update a specific port-group

PUT /port-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port-group optional		PortGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port-group

DELETE /port-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 port-group

GET /port-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 port-group

POST /port-groups

Parameters

Type	Name	Description	Schema	Default
body	port-group required	Body of port-group resource	PortGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific virtual-port-group

GET /virtual-port-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	VirtualPortGroupReadAll
404	Not Found	Error

Update a specific virtual-port-group

PUT /virtual-port-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-port-group optional		VirtualPortGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-port-group

DELETE /virtual-port-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 virtual-port-group

GET /virtual-port-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 virtual-port-group

POST /virtual-port-groups

Parameters

Type	Name	Description	Schema	Default
body	virtual-port-group required	Body of virtual-port-group resource	VirtualPortGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

port-profile

Data Model

Description

Encapsulates port configurations like storm control, QoS etc

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
port-profile-params	This is to configure port attributes.	False	PortProfileParameters	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:storm-control-profile storm-control-profile-label	Storm control profile that this port profile 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-machine-interface virtual-machine-interface-label, :ref:virtual-port-group virtual-port-group-label

REST API

Fetch a specific port-profile

GET /port-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	PortProfileReadAll
404	Not Found	Error

Update a specific port-profile

PUT /port-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port-profile optional		PortProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port-profile

DELETE /port-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 port-profile

GET /port-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 port-profile

POST /port-profiles

Parameters

Type	Name	Description	Schema	Default
body	port-profile required	Body of port-profile resource	PortProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

port-tuple

Data Model

Description

Port tuples are ordered set of interfaces that represent a service virtual machine or physical device , which is part of this service instance. Order of interfaces in port tuple is same as specified in the service template. example SI = [(Left, Right, Management), (L, R, M), ..., (L, R, M)].

Parents: service-instance

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:logical-router logical-router-label	list of tenant logical routers to be attached to the service left or right attachment point	False	None	CRUD	user
:ref:virtual-network virtual-network-label	Internal virtual networks for PNF left or right service attachment points are used to internally to allocate route targets for the left and right service VRFs on the spine device	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-machine-interface virtual-machine-interface-label

REST API

Fetch a specific port-tuple

GET /port-tuple/{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	PortTupleReadAll
404	Not Found	Error

Update a specific port-tuple

PUT /port-tuple/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	port-tuple optional		PortTupleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific port-tuple

DELETE /port-tuple/{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 port-tuple

GET /port-tuples

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 port-tuple

POST /port-tuples

Parameters

Type	Name	Description	Schema	Default
body	port-tuple required	Body of port-tuple resource	PortTupleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

project

Data Model

Description

Project represent one instance of application or tenant.

Parents: domain

Children

address-group, alarm, api-access-list, application-policy-set, bgp-as-a-service, bgpvpn, firewall-policy, firewall-rule, host-based-service, interface-route-table, loadbalancer, loadbalancer-healthmonitor, loadbalancer-listener, loadbalancer-pool, logical-router, multicast-policy, network-ipam, network-policy, policy-management, qos-config, route-aggregate, route-table, routing-policy, security-group, security-logging-object, service-group, service-health-check, service-instance, tag, virtual-ip, virtual-machine-interface, virtual-network, virtual-port-group

Properties

Name	Description	Required	Type	Operations	Created By
mtu	MTU attribute for the virtual network	False	number	CRUD	user
quota	Max instances limits for various objects under project.	True	QuotaType	CRUD	user
vxlan-routing	When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical router in the project.	False	boolean	CRUD	user
alarm-enable	Flag to enable/disable alarms configured under global-system-config. True, if not set.	False	boolean	CRUD	user
enable-security-policy-draft	None	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:namespace namespace-label	Reference to network namespace of this project.	False	SubnetType	CRUD	user
:ref:floating-ip-pool floating-ip-pool-label	Deprecated as it is not needed. Will be removed in future.	False	None	CRUD	user
:ref:alias-ip-pool alias-ip-pool-label	Reference to alias ip pool in this project.	False	None	CRUD	user
:ref:application-policy-set application-policy-set-label	Reference to default application-policy-set is automatically created by system for default socped application policy sets. Needed by vrouter to identify default application-policy-set rules of a virtual machine interface	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:floating-ip floating-ip-label, :ref:alias-ip alias-ip-label

REST API

Fetch a specific project

GET /project/{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	ProjectReadAll
404	Not Found	Error

Update a specific project

PUT /project/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	project optional		ProjectUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific project

DELETE /project/{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 project

GET /projects

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 project

POST /projects

Parameters

Type	Name	Description	Schema	Default
body	project required	Body of project resource	ProjectCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

provider-attachment

Data Model

Description

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-router virtual-router-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 provider-attachment

GET /provider-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	ProviderAttachmentReadAll
404	Not Found	Error

Update a specific provider-attachment

PUT /provider-attachment/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	provider-attachment optional		ProviderAttachmentUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific provider-attachment

DELETE /provider-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 provider-attachment

GET /provider-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 provider-attachment

POST /provider-attachments

Parameters

Type	Name	Description	Schema	Default
body	provider-attachment required	Body of provider-attachment resource	ProviderAttachmentCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

qos-config

Data Model

Description

When parent is global-qos-config,

Global system QoS config for vhost and fabric traffic .

When parent is project,

Parents: global-qos-config, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
qos-config-type	Specifies if qos-config is for vhost, fabric or for project.	True	string	CRUD	user
dscp-entries	Map of DSCP match condition and applicable forwarding class for packet.	False	QosIdForwardingClassPairs	CRUD	user
vlan-priority-entries	Map of .1p priority code to applicable forwarding class for packet.	False	QosIdForwardingClassPairs	CRUD	user
mpls-exp-entries	Map of MPLS EXP values to applicable forwarding class for packet.	False	QosIdForwardingClassPairs	CRUD	user
default-forwarding-class-id	Default forwarding class used for all non-specified QOS bits	True	number	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:global-system-config global-system-config-label	This link is internally created and may be removed in future. End users should not set this link or assume it to be there	False	None	CR	system
: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:virtual-network virtual-network-label

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

Fetch a specific qos-config

GET /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	QosConfigReadAll
404	Not Found	Error

Update a specific qos-config

PUT /qos-config/{id}

Parameters

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

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific qos-config

DELETE /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 qos-config

GET /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 qos-config

POST /qos-configs

Parameters

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

Responses

HTTP Code	Description	Schema
200	Success	Uuid

qos-queue

Data Model

Description

QOS queue config object in this project.

Parents: global-qos-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
min-bandwidth	Minimum bandwidth for this queue.	True	number	CRUD	user
max-bandwidth	Maximum bandwidth for this queue.	True	number	CRUD	user
qos-queue-identifier	Unique id for this queue.	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:forwarding-class forwarding-class-label

REST API

Fetch a specific qos-queue

GET /qos-queue/{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	QosQueueReadAll
404	Not Found	Error

Update a specific qos-queue

PUT /qos-queue/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	qos-queue optional		QosQueueUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific qos-queue

DELETE /qos-queue/{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 qos-queue

GET /qos-queues

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 qos-queue

POST /qos-queues

Parameters

Type	Name	Description	Schema	Default
body	qos-queue required	Body of qos-queue resource	QosQueueCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

role-config

Data Model

Description

This resource exposes to users additional parameters to configure a specify physical or routing/switching roles. These are the config parameters that are mot modeled in VNC data model and we don’t want to hard code in the fabric ansible playbooks. These could be vendor specific parameters or could be extended by the field or customer who might want to tweak the playbooks. The schema for the role config are defined in the job-template.input_schema. This schema could be used by the UI to generically render the form for user to edit the config.

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
role-config-config	role config in JSON format. This JSON config must conform to the input-schema of the job template for the role 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 role-config

GET /role-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	RoleConfigReadAll
404	Not Found	Error

Update a specific role-config

PUT /role-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	role-config optional		RoleConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific role-config

DELETE /role-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 role-config

GET /role-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 role-config

POST /role-configs

Parameters

Type	Name	Description	Schema	Default
body	role-config required	Body of role-config resource	RoleConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

role-definition

Data Model

Description

Defines a role combination which comprises of a physical role and overlay role and the features associated with it.

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:feature feature-label	list of features for this role definition.	False	None	CRUD	user
:ref:physical-role physical-role-label	physical role for this role definition.	False	None	CRUD	user
:ref:overlay-role overlay-role-label	overlay role for this role definition.	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

REST API

Fetch a specific role-definition

GET /role-definition/{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	RoleDefinitionReadAll
404	Not Found	Error

Update a specific role-definition

PUT /role-definition/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	role-definition optional		RoleDefinitionUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific role-definition

DELETE /role-definition/{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 role-definition

GET /role-definitions

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 role-definition

POST /role-definitions

Parameters

Type	Name	Description	Schema	Default
body	role-definition required	Body of role-definition resource	RoleDefinitionCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

route-aggregate

Data Model

Description

List of references of child routing route aggregate objects. automatically maintained by system.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
aggregate-route-entries	List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This aggregate route is advertised if a matching(longest prefix match) prefix is found.	True	RouteListType	CRUD	user
aggregate-route-nexthop	Next for aggregate route that will be advertised.	True	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-instance service-instance-label	Reference to route-aggregate policy attached to (service instance, interface).	False	ServiceInterfaceTag	CRUD	user
:ref:routing-instance routing-instance-label	Reference to internal routing instance object automatically generated by 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 route-aggregate

GET /route-aggregate/{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	RouteAggregateReadAll
404	Not Found	Error

Update a specific route-aggregate

PUT /route-aggregate/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	route-aggregate optional		RouteAggregateUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific route-aggregate

DELETE /route-aggregate/{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 route-aggregate

GET /route-aggregates

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 route-aggregate

POST /route-aggregates

Parameters

Type	Name	Description	Schema	Default
body	route-aggregate required	Body of route-aggregate resource	RouteAggregateCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

route-table

Data Model

Description

Network route table is mechanism of adding static routes in the virtual network

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
routes	Routes in the route table are configured in following way.	True	RouteTableType	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, :ref:logical-router logical-router-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

Fetch a specific route-table

GET /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	RouteTableReadAll
404	Not Found	Error

Update a specific route-table

PUT /route-table/{id}

Parameters

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

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific route-table

DELETE /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 route-table

GET /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 route-table

POST /route-tables

Parameters

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

Responses

HTTP Code	Description	Schema
200	Success	Uuid

route-target

Data Model

Description

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

:ref:routing-instance routing-instance-label, :ref:logical-router logical-router-label

REST API

Fetch a specific route-target

GET /route-target/{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	RouteTargetReadAll
404	Not Found	Error

Update a specific route-target

PUT /route-target/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	route-target optional		RouteTargetUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific route-target

DELETE /route-target/{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 route-target

GET /route-targets

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 route-target

POST /route-targets

Parameters

Type	Name	Description	Schema	Default
body	route-target required	Body of route-target resource	RouteTargetCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

routing-instance

Data Model

Description

List of references of routing instances for this virtual network, routing instances are internal to the system.

Parents: virtual-network

Children

bgp-router

Properties

Name	Description	Required	Type	Operations	Created By
service-chain-information	Internal service chaining information, should not be modified.	False	ServiceChainInfo	CRUD	system
ipv6-service-chain-information	Internal service chaining information, should not be modified.	False	ServiceChainInfo	CRUD	system
evpn-service-chain-information	Internal service chaining information, should not be modified.	False	ServiceChainInfo	CRUD	system
evpn-ipv6-service-chain-information	Internal service chaining information, should not be modified.	False	ServiceChainInfo	CRUD	system
routing-instance-is-default	Internal service chaining information, should not be modified.	False	boolean	CRUD	system
routing-instance-has-pnf	Internal service chaining information, should not be modified.	False	boolean	CRUD	system
routing-instance-id	System assigned unique ID for every routing instance.	False	number	CR	system
static-route-entries	Internal service chaining information, should not be modified.	False	StaticRouteEntriesType	CRUD	system
routing-instance-fabric-snat	Provide connectivity to underlay network by port mapping trafficwith source IP of compute node	False	boolean	CRUD	system
default-ce-protocol	None	False	DefaultProtocolType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:routing-instance routing-instance-label		False	ConnectionType	CRUD	user
:ref:route-target route-target-label		False	InstanceTargetType	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:route-aggregate route-aggregate-label, :ref:routing-policy routing-policy-label

REST API

Fetch a specific routing-instance

GET /routing-instance/{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	RoutingInstanceReadAll
404	Not Found	Error

Update a specific routing-instance

PUT /routing-instance/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	routing-instance optional		RoutingInstanceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific routing-instance

DELETE /routing-instance/{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 routing-instance

GET /routing-instances

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 routing-instance

POST /routing-instances

Parameters

Type	Name	Description	Schema	Default
body	routing-instance required	Body of routing-instance resource	RoutingInstanceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

routing-policy

Data Model

Description

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

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
routing-policy-entries	None	False	PolicyStatementType	CRUD	user
term-type	None	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:interface-route-table interface-route-table-label	Reference to interface route table attached to routing policy.	False	None	CRUD	user
:ref:service-instance service-instance-label	Reference to routing policy attached to (service instance, interface).	False	RoutingPolicyServiceInstanceType	CRUD	user
:ref:routing-instance routing-instance-label		False	RoutingPolicyType	CRUD	user
: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:data-center-interconnect data-center-interconnect-label

REST API

Fetch a specific routing-policy

GET /routing-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	RoutingPolicyReadAll
404	Not Found	Error

Update a specific routing-policy

PUT /routing-policy/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	routing-policy optional		RoutingPolicyUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific routing-policy

DELETE /routing-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 routing-policy

GET /routing-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 routing-policy

POST /routing-policys

Parameters

Type	Name	Description	Schema	Default
body	routing-policy required	Body of routing-policy resource	RoutingPolicyCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

security-group

Data Model

Description

Security Groups are set of state full access control rules attached to interfaces.It can be used to implement microsegmentation.

Parents: project

Children

access-control-list

Properties

Name	Description	Required	Type	Operations	Created By
security-group-id	Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].	False	number	R	system
configured-security-group-id	Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].	False	number	CRUD	user
security-group-entries	Security group rule entries.	True	PolicyEntriesType	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:security-logging-object security-logging-object-label, :ref:virtual-machine-interface virtual-machine-interface-label, :ref:virtual-port-group virtual-port-group-label

REST API

Fetch a specific security-group

GET /security-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	SecurityGroupReadAll
404	Not Found	Error

Update a specific security-group

PUT /security-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	security-group optional		SecurityGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific security-group

DELETE /security-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 security-group

GET /security-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 security-group

POST /security-groups

Parameters

Type	Name	Description	Schema	Default
body	security-group required	Body of security-group resource	SecurityGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

security-logging-object

Data Model

Description

When parent is global-vrouter-config,

Reference to security logging object for global-vrouter-config.

When parent is project,

Security logging object configuration for specifying session logging criteria

Parents: global-vrouter-config, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
security-logging-object-rules	Security logging object rules derived internally.	False	SecurityLoggingObjectRuleListType	CRUD	user
security-logging-object-rate	Security logging object rate defining rate of session logging	False	number	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:network-policy network-policy-label	Reference to network-policy attached to this security-logging-object	False	SecurityLoggingObjectRuleListType	CRUD	user
:ref:security-group security-group-label	Reference to security-group attached to this security-logging-object	False	SecurityLoggingObjectRuleListType	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:firewall-policy firewall-policy-label, :ref:firewall-rule firewall-rule-label, :ref:virtual-network virtual-network-label

REST API

Fetch a specific security-logging-object

GET /security-logging-object/{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	SecurityLoggingObjectReadAll
404	Not Found	Error

Update a specific security-logging-object

PUT /security-logging-object/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	security-logging-object optional		SecurityLoggingObjectUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific security-logging-object

DELETE /security-logging-object/{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 security-logging-object

GET /security-logging-objects

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 security-logging-object

POST /security-logging-objects

Parameters

Type	Name	Description	Schema	Default
body	security-logging-object required	Body of security-logging-object resource	SecurityLoggingObjectCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-appliance

Data Model

Description

Service appliance is a member in service appliance set (e.g. Loadbalancer, Firewall provider).By default system will create “ha-proxy” based service appliance.

Parents: service-appliance-set

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
service-appliance-user-credentials	Authentication credentials for driver to access service appliance.	False	UserCredentials	CRUD	user
service-appliance-ip-address	Management Ip address of the service-appliance.	True	string	CRUD	user
service-appliance-virtualization-type	Service virtualization type decides how individual service instances are instantiated	False	string	CRUD	user
service-appliance-properties	List of Key:Value pairs used by the provider driver of this service appliance.	True	KeyValuePairs	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:physical-interface physical-interface-label	Reference to physical interface that can be used as (service interface type)left, right, management OR other.	False	ServiceApplianceInterfaceType	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 service-appliance

GET /service-appliance/{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	ServiceApplianceReadAll
404	Not Found	Error

Update a specific service-appliance

PUT /service-appliance/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-appliance optional		ServiceApplianceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-appliance

DELETE /service-appliance/{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 service-appliance

GET /service-appliances

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 service-appliance

POST /service-appliances

Parameters

Type	Name	Description	Schema	Default
body	service-appliance required	Body of service-appliance resource	ServiceApplianceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific service-appliance-set

GET /service-appliance-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	ServiceApplianceSetReadAll
404	Not Found	Error

Update a specific service-appliance-set

PUT /service-appliance-set/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-appliance-set optional		ServiceApplianceSetUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-appliance-set

DELETE /service-appliance-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 service-appliance-set

GET /service-appliance-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 service-appliance-set

POST /service-appliance-sets

Parameters

Type	Name	Description	Schema	Default
body	service-appliance-set required	Body of service-appliance-set resource	ServiceApplianceSetCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-appliance-set

Data Model

Description

Service appliance set is the collection of service appliances. This collection is used as a provider in loadbalancer pool config. Algorithm to distribute/choose one appliance over other can be built while creating loadbalancer pool. By default, system will create service-appliance-set with name “opencontrail”. This is the default loadbalancer provider for pools in Contrail. This provider is based on “ha-proxy”.Service appliance set has following attribute - Driver to load for provisioning the appliance Service appliance properties - HA mode.

Parents: global-system-config

Children

service-appliance

Properties

Name	Description	Required	Type	Operations	Created By
service-appliance-set-virtualization-type	Service virtualization type decides how individual service instances are instantiated	False	string	CRUD	user
service-appliance-set-properties	List of Key:Value pairs that are used by the provider driver and opaque to system.	False	KeyValuePairs	CRUD	user
service-appliance-driver	Name of the provider driver for this service appliance set.	False	string	CRUD	user
service-appliance-ha-mode	High availability mode for the service appliance set, active-active or active-backup.	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:service-template service-template-label, :ref:loadbalancer-pool loadbalancer-pool-label, :ref:loadbalancer loadbalancer-label

REST API

Fetch a specific service-appliance-set

GET /service-appliance-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	ServiceApplianceSetReadAll
404	Not Found	Error

Update a specific service-appliance-set

PUT /service-appliance-set/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-appliance-set optional		ServiceApplianceSetUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-appliance-set

DELETE /service-appliance-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 service-appliance-set

GET /service-appliance-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 service-appliance-set

POST /service-appliance-sets

Parameters

Type	Name	Description	Schema	Default
body	service-appliance-set required	Body of service-appliance-set resource	ServiceApplianceSetCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-connection-module

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
e2-service	E2 service type.	True	string	CRUD	user
service-type	Type of service assigned for this object	True	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-object service-object-label	Links the service-connection-module to a service object.	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-endpoint service-endpoint-label

REST API

Fetch a specific service-connection-module

GET /service-connection-module/{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	ServiceConnectionModuleReadAll
404	Not Found	Error

Update a specific service-connection-module

PUT /service-connection-module/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-connection-module optional		ServiceConnectionModuleUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-connection-module

DELETE /service-connection-module/{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 service-connection-module

GET /service-connection-modules

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 service-connection-module

POST /service-connection-modules

Parameters

Type	Name	Description	Schema	Default
body	service-connection-module required	Body of service-connection-module resource	ServiceConnectionModuleCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-endpoint

Data Model

Description

Parents: None

Children

None

Properties

References

To	Description	Required	Type	Operations	Created By
:ref:service-connection-module service-connection-module-label	Link the service endpoint to service connection node	False	None	CRUD	user
:ref:physical-router physical-router-label	Reference to Router for a given service.	False	None	CRUD	user
:ref:service-object service-object-label	Links the service-endpoints to a service object.	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-machine-interface virtual-machine-interface-label

REST API

Fetch a specific service-endpoint

GET /service-endpoint/{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	ServiceEndpointReadAll
404	Not Found	Error

Update a specific service-endpoint

PUT /service-endpoint/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-endpoint optional		ServiceEndpointUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-endpoint

DELETE /service-endpoint/{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 service-endpoint

GET /service-endpoints

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 service-endpoint

POST /service-endpoints

Parameters

Type	Name	Description	Schema	Default
body	service-endpoint required	Body of service-endpoint resource	ServiceEndpointCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-group

Data Model

Description

When parent is policy-management,

Service Group object

When parent is project,

Project level service Group object

Parents: policy-management, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
draft-mode-state	None	False	string	R	user
service-group-firewall-service-list	list of service objects (protocol, source port and destination port	True	FirewallServiceGroupType	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 service-group

GET /service-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	ServiceGroupReadAll
404	Not Found	Error

Update a specific service-group

PUT /service-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-group optional		ServiceGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-group

DELETE /service-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 service-group

GET /service-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 service-group

POST /service-groups

Parameters

Type	Name	Description	Schema	Default
body	service-group required	Body of service-group resource	ServiceGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-health-check

Data Model

Description

Service health check is a keepalive mechanism for the virtual machine interface. Liveliness of the interface is determined based on configuration in the service health check. It is mainly designed for service instance interfaces. However it will work with any interface which present on contrail vrouter.

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
service-health-check-properties	Service health check has following fields.	True	ServiceHealthCheckType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-instance service-instance-label	Reference to service instance using this service health check.	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:bgp-as-a-service bgp-as-a-service-label, :ref:virtual-machine-interface virtual-machine-interface-label, :ref:virtual-network virtual-network-label

REST API

Fetch a specific service-health-check

GET /service-health-check/{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	ServiceHealthCheckReadAll
404	Not Found	Error

Update a specific service-health-check

PUT /service-health-check/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-health-check optional		ServiceHealthCheckUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-health-check

DELETE /service-health-check/{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 service-health-check

GET /service-health-checks

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 service-health-check

POST /service-health-checks

Parameters

Type	Name	Description	Schema	Default
body	service-health-check required	Body of service-health-check resource	ServiceHealthCheckCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-instance

Data Model

Description

Service instance represents logical instance service used in the virtual world, e.g. firewall, load balancer etc. It can represent one or multiple virtual machines or physical devices. Many service instances can share a virtual machine or physical device.

Parents: project

Children

port-tuple

Properties

Name	Description	Required	Type	Operations	Created By
service-instance-properties	Service instance configuration parameters.	True	ServiceInstanceType	CRUD	user
service-instance-bindings	Opaque key value pair for generating config for the service instance.	False	KeyValuePairs	CRUD	user
service-instance-bgp-enabled	Enable BGP routing for this service instance	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-template service-template-label	Reference to the service template of this service instance.	True	None	CRUD	user
:ref:instance-ip instance-ip-label	Reference to ip address, which is used as nexthop pointing to (service instance, service interface).	False	ServiceInterfaceTag	CRUD	system
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:routing-policy routing-policy-label, :ref:service-health-check service-health-check-label, :ref:loadbalancer loadbalancer-label, :ref:virtual-machine virtual-machine-label, :ref:interface-route-table interface-route-table-label, :ref:loadbalancer-pool loadbalancer-pool-label, :ref:route-aggregate route-aggregate-label, :ref:logical-router logical-router-label

REST API

Fetch a specific service-instance

GET /service-instance/{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	ServiceInstanceReadAll
404	Not Found	Error

Update a specific service-instance

PUT /service-instance/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-instance optional		ServiceInstanceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-instance

DELETE /service-instance/{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 service-instance

GET /service-instances

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 service-instance

POST /service-instances

Parameters

Type	Name	Description	Schema	Default
body	service-instance required	Body of service-instance resource	ServiceInstanceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-object

Data Model

Description

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

:ref:service-connection-module service-connection-module-label, :ref:service-endpoint service-endpoint-label

REST API

Fetch a specific service-object

GET /service-object/{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	ServiceObjectReadAll
404	Not Found	Error

Update a specific service-object

PUT /service-object/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-object optional		ServiceObjectUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-object

DELETE /service-object/{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 service-object

GET /service-objects

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 service-object

POST /service-objects

Parameters

Type	Name	Description	Schema	Default
body	service-object required	Body of service-object resource	ServiceObjectCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

service-template

Data Model

Description

Service template defines how a service may be deployed in the network. Service instance is instantiated from config in service template.

Parents: domain

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
service-template-properties	Service template configuration parameters.	True	ServiceTemplateType	CRUD	user
service-config-managed	Enable whether service config for PNFs needs to be managed by Contrail	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-appliance-set service-appliance-set-label	Reference to the service appliance set represented by this service template.	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 service-template

GET /service-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	ServiceTemplateReadAll
404	Not Found	Error

Update a specific service-template

PUT /service-template/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	service-template optional		ServiceTemplateUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific service-template

DELETE /service-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 service-template

GET /service-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 service-template

POST /service-templates

Parameters

Type	Name	Description	Schema	Default
body	service-template required	Body of service-template resource	ServiceTemplateCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

sflow-profile

Data Model

Description

This resource contains information specific to sflow parameters

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
sflow-profile-is-default	This attribute indicates whether it is a default sflow profile or not. Default profiles are non- editable.	False	boolean	CRUD	user
sflow-parameters	Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled interfaces, sflow agent ID etc.	False	SflowParameters	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 sflow-profile

GET /sflow-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	SflowProfileReadAll
404	Not Found	Error

Update a specific sflow-profile

PUT /sflow-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	sflow-profile optional		SflowProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific sflow-profile

DELETE /sflow-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 sflow-profile

GET /sflow-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 sflow-profile

POST /sflow-profiles

Parameters

Type	Name	Description	Schema	Default
body	sflow-profile required	Body of sflow-profile resource	SflowProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

snmp-profile

Data Model

Description

This resource contains information specific to snmp parameters

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
snmp-profile-is-default	This attribute indicates whether it is a default snmp profile or not. Default profiles are non- editable.	False	boolean	CRUD	user
snmp-parameters	Parameters for each snmp profile like the top level sensor options etc.	False	SnmpParameters	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 snmp-profile

GET /snmp-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	SnmpProfileReadAll
404	Not Found	Error

Update a specific snmp-profile

PUT /snmp-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	snmp-profile optional		SnmpProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific snmp-profile

DELETE /snmp-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 snmp-profile

GET /snmp-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 snmp-profile

POST /snmp-profiles

Parameters

Type	Name	Description	Schema	Default
body	snmp-profile required	Body of snmp-profile resource	SnmpProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

storm-control-profile

Data Model

Description

Storm control profile definition

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
storm-control-parameters	Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type, receovery timeout etc.	False	StormControlParameters	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:port-profile port-profile-label

REST API

Fetch a specific storm-control-profile

GET /storm-control-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	StormControlProfileReadAll
404	Not Found	Error

Update a specific storm-control-profile

PUT /storm-control-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	storm-control-profile optional		StormControlProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific storm-control-profile

DELETE /storm-control-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 storm-control-profile

GET /storm-control-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 storm-control-profile

POST /storm-control-profiles

Parameters

Type	Name	Description	Schema	Default
body	storm-control-profile required	Body of storm-control-profile resource	StormControlProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

structured-syslog-application-record

Data Model

Description

mapping App name to other entities

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
structured-syslog-app-category	The application category	True	string	CRUD	user
structured-syslog-app-subcategory	The application sub category	False	string	CRUD	user
structured-syslog-app-groups	app groups comma separated	False	string	CRUD	user
structured-syslog-app-risk	The application risk profile	False	string	CRUD	user
structured-syslog-app-service-tags	service-tags corresponding to applications	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 structured-syslog-application-record

GET /structured-syslog-application-record/{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	StructuredSyslogApplicationRecordReadAll
404	Not Found	Error

Update a specific structured-syslog-application-record

PUT /structured-syslog-application-record/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	structured-syslog-application-record optional		StructuredSyslogApplicationRecordUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific structured-syslog-application-record

DELETE /structured-syslog-application-record/{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 structured-syslog-application-record

GET /structured-syslog-application-records

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 structured-syslog-application-record

POST /structured-syslog-application-records

Parameters

Type	Name	Description	Schema	Default
body	structured-syslog-application-record required	Body of structured-syslog-application-record resource	StructuredSyslogApplicationRecordCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

structured-syslog-config

Data Model

Description

structured syslog 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 structured-syslog-config

GET /structured-syslog-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	StructuredSyslogConfigReadAll
404	Not Found	Error

Update a specific structured-syslog-config

PUT /structured-syslog-config/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	structured-syslog-config optional		StructuredSyslogConfigUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific structured-syslog-config

DELETE /structured-syslog-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 structured-syslog-config

GET /structured-syslog-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 structured-syslog-config

POST /structured-syslog-configs

Parameters

Type	Name	Description	Schema	Default
body	structured-syslog-config required	Body of structured-syslog-config resource	StructuredSyslogConfigCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

structured-syslog-hostname-record

Data Model

Description

mapping Hostname to other entities

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
structured-syslog-hostaddr	The host address	True	string	CRUD	user
structured-syslog-tenant	The tenant name	True	string	CRUD	user
structured-syslog-location	location details	True	string	CRUD	user
structured-syslog-device	device id	False	string	CRUD	user
structured-syslog-hostname-tags	tags corresponding to the host	False	string	CRUD	user
structured-syslog-linkmap	overlay to underlay mapping	False	StructuredSyslogLinkmap	CRUD	user
structured-syslog-lan-segment-list	vpn to network-ranges mapping	False	StructuredSyslogLANSegmentList	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 structured-syslog-hostname-record

GET /structured-syslog-hostname-record/{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	StructuredSyslogHostnameRecordReadAll
404	Not Found	Error

Update a specific structured-syslog-hostname-record

PUT /structured-syslog-hostname-record/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	structured-syslog-hostname-record optional		StructuredSyslogHostnameRecordUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific structured-syslog-hostname-record

DELETE /structured-syslog-hostname-record/{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 structured-syslog-hostname-record

GET /structured-syslog-hostname-records

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 structured-syslog-hostname-record

POST /structured-syslog-hostname-records

Parameters

Type	Name	Description	Schema	Default
body	structured-syslog-hostname-record required	Body of structured-syslog-hostname-record resource	StructuredSyslogHostnameRecordCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

structured-syslog-message

Data Model

Description

structured syslog messages to be handled

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
structured-syslog-message-tagged-fields	list of field names in the message to be tagged	True	FieldNamesList	CRUD	user
structured-syslog-message-integer-fields	list of integer fields in the message	True	FieldNamesList	CRUD	user
structured-syslog-message-process-and-store	message is to be processed and stored or not	True	boolean	CRUD	user
structured-syslog-message-process-and-summarize	message is to be processed and summarized or not	True	boolean	CRUD	user
structured-syslog-message-process-and-summarize-user	message is to be processed and summarized for user or not	True	boolean	CRUD	user
structured-syslog-message-forward	fowarding action to be taken on the message	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 structured-syslog-message

GET /structured-syslog-message/{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	StructuredSyslogMessageReadAll
404	Not Found	Error

Update a specific structured-syslog-message

PUT /structured-syslog-message/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	structured-syslog-message optional		StructuredSyslogMessageUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific structured-syslog-message

DELETE /structured-syslog-message/{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 structured-syslog-message

GET /structured-syslog-messages

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 structured-syslog-message

POST /structured-syslog-messages

Parameters

Type	Name	Description	Schema	Default
body	structured-syslog-message required	Body of structured-syslog-message resource	StructuredSyslogMessageCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

structured-syslog-sla-profile

Data Model

Description

mapping sla-profile to sla params

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
structured-syslog-sla-params	The sla params like sampling %age and traffic type	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 structured-syslog-sla-profile

GET /structured-syslog-sla-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	StructuredSyslogSlaProfileReadAll
404	Not Found	Error

Update a specific structured-syslog-sla-profile

PUT /structured-syslog-sla-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	structured-syslog-sla-profile optional		StructuredSyslogSlaProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific structured-syslog-sla-profile

DELETE /structured-syslog-sla-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 structured-syslog-sla-profile

GET /structured-syslog-sla-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 structured-syslog-sla-profile

POST /structured-syslog-sla-profiles

Parameters

Type	Name	Description	Schema	Default
body	structured-syslog-sla-profile required	Body of structured-syslog-sla-profile resource	StructuredSyslogSlaProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

structured-syslog-tenant-record

Data Model

Description

mapping Tenant to other entities

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
structured-syslog-tenant	The tenant name	True	string	CRUD	user
structured-syslog-tenantaddr	The tenant address	True	string	CRUD	user
structured-syslog-tenant-tags	tags corresponding to the tenant	False	string	CRUD	user
structured-syslog-dscpmap	dscp to Alias mapping	False	StructuredSyslogDSCPMap	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 structured-syslog-tenant-record

GET /structured-syslog-tenant-record/{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	StructuredSyslogTenantRecordReadAll
404	Not Found	Error

Update a specific structured-syslog-tenant-record

PUT /structured-syslog-tenant-record/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	structured-syslog-tenant-record optional		StructuredSyslogTenantRecordUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific structured-syslog-tenant-record

DELETE /structured-syslog-tenant-record/{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 structured-syslog-tenant-record

GET /structured-syslog-tenant-records

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 structured-syslog-tenant-record

POST /structured-syslog-tenant-records

Parameters

Type	Name	Description	Schema	Default
body	structured-syslog-tenant-record required	Body of structured-syslog-tenant-record resource	StructuredSyslogTenantRecordCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

sub-cluster

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
sub-cluster-asn	AS number of that cluster.	True	number	CRUD	user
sub-cluster-id	Unique 16 or 32 bit ID assigned to this sub-cluster. User can define the ID he wants to use.	False	number	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

:ref:bgp-router bgp-router-label, :ref:virtual-router virtual-router-label

REST API

Fetch a specific sub-cluster

GET /sub-cluster/{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	SubClusterReadAll
404	Not Found	Error

Update a specific sub-cluster

PUT /sub-cluster/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	sub-cluster optional		SubClusterUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific sub-cluster

DELETE /sub-cluster/{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 sub-cluster

GET /sub-clusters

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 sub-cluster

POST /sub-clusters

Parameters

Type	Name	Description	Schema	Default
body	sub-cluster required	Body of sub-cluster resource	SubClusterCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

subnet

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
subnet-ip-prefix	Ip prefix/length of the subnet.	True	SubnetType	CRD	user

References

To	Description	Required	Type	Operations	Created By
:ref:virtual-machine-interface virtual-machine-interface-label	Subnet belongs of the referenced virtual machine interface. This is used in CPE use case when a subnet is reachable via the interface. It also serves as dynamic DHCP pool for host on this LAN, where vrouter is DHCP server.	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 subnet

GET /subnet/{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	SubnetReadAll
404	Not Found	Error

Update a specific subnet

PUT /subnet/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	subnet optional		SubnetUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific subnet

DELETE /subnet/{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 subnet

GET /subnets

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 subnet

POST /subnets

Parameters

Type	Name	Description	Schema	Default
body	subnet required	Body of subnet resource	SubnetCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

tag

Data Model

Description

When parent is project,

Attribute attached to objects - has a type and value

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
tag-type-name	Tag type string representation	True	string	CR	user
tag-value	Tag value string representation	True	string	CR	user
tag-predefined	Tag delete boolean representation	False	boolean	CR	user
tag-id	Internal Tag ID encapsulating tag type and value in hexadecimal fomat: 0xTTTTVVVV (T: type, V: value)	False	string	R	user

References

To	Description	Required	Type	Operations	Created By
:ref:tag-type tag-type-label	Tag type reference which is limited to one	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-endpoint service-endpoint-label, :ref:instance-ip instance-ip-label, :ref:service-appliance-set service-appliance-set-label, :ref:dsa-rule dsa-rule-label, :ref:discovery-service-assignment discovery-service-assignment-label, :ref:floating-ip-pool floating-ip-pool-label, :ref:physical-router physical-router-label, :ref:config-root config-root-label, :ref:service-template service-template-label, :ref:hardware-inventory hardware-inventory-label, :ref:firewall-policy firewall-policy-label, :ref:route-table route-table-label, :ref:provider-attachment provider-attachment-label, :ref:overlay-role overlay-role-label, :ref:config-properties config-properties-label, :ref:network-device-config network-device-config-label, :ref:virtual-DNS-record virtual-DNS-record-label, :ref:control-node-zone control-node-zone-label, :ref:route-target route-target-label, :ref:structured-syslog-config structured-syslog-config-label, :ref:loadbalancer-listener loadbalancer-listener-label, :ref:logical-interface logical-interface-label, :ref:flow-node flow-node-label, :ref:port-group port-group-label, :ref:route-aggregate route-aggregate-label, :ref:logical-router logical-router-label, :ref:domain domain-label, :ref:structured-syslog-hostname-record structured-syslog-hostname-record-label, :ref:routing-policy routing-policy-label, :ref:node-profile node-profile-label, :ref:bridge-domain bridge-domain-label, :ref:alias-ip alias-ip-label, :ref:network-policy network-policy-label, :ref:port port-label, :ref:bgp-as-a-service bgp-as-a-service-label, :ref:subnet subnet-label, :ref:global-system-config global-system-config-label, :ref:sub-cluster sub-cluster-label, :ref:forwarding-class forwarding-class-label, :ref:service-group service-group-label, :ref:global-analytics-config global-analytics-config-label, :ref:address-group address-group-label, :ref:application-policy-set application-policy-set-label, :ref:virtual-ip virtual-ip-label, :ref:intent-map intent-map-label, :ref:port-tuple port-tuple-label, :ref:analytics-alarm-node analytics-alarm-node-label, :ref:netconf-profile netconf-profile-label, :ref:qos-queue qos-queue-label, :ref:physical-role physical-role-label, :ref:card card-label, :ref:global-qos-config global-qos-config-label, :ref:qos-config qos-config-label, :ref:analytics-snmp-node analytics-snmp-node-label, :ref:virtual-machine-interface virtual-machine-interface-label, :ref:cli-config cli-config-label, :ref:service-object service-object-label, :ref:feature-flag feature-flag-label, :ref:loadbalancer loadbalancer-label, :ref:structured-syslog-tenant-record structured-syslog-tenant-record-label, :ref:peering-policy peering-policy-label, :ref:structured-syslog-application-record structured-syslog-application-record-label, :ref:global-vrouter-config global-vrouter-config-label, :ref:webui-node webui-node-label, :ref:floating-ip floating-ip-label, :ref:link-aggregation-group link-aggregation-group-label, :ref:virtual-router virtual-router-label, :ref:port-profile port-profile-label, :ref:policy-management policy-management-label, :ref:e2-service-provider e2-service-provider-label, :ref:fabric fabric-label, :ref:job-template job-template-label, :ref:service-instance service-instance-label, :ref:role-config role-config-label, :ref:tag-type tag-type-label, :ref:structured-syslog-message structured-syslog-message-label, :ref:loadbalancer-pool loadbalancer-pool-label, :ref:security-logging-object security-logging-object-label, :ref:analytics-node analytics-node-label, :ref:virtual-DNS virtual-DNS-label, :ref:config-database-node config-database-node-label, :ref:config-node config-node-label, :ref:device-functional-group device-functional-group-label, :ref:firewall-rule firewall-rule-label, :ref:bgpvpn bgpvpn-label, :ref:role-definition role-definition-label, :ref:service-connection-module service-connection-module-label, :ref:security-group security-group-label, :ref:database-node database-node-label, :ref:loadbalancer-healthmonitor loadbalancer-healthmonitor-label, :ref:devicemgr-node devicemgr-node-label, :ref:project project-label, :ref:fabric-namespace fabric-namespace-label, :ref:alarm alarm-label, :ref:multicast-policy multicast-policy-label, :ref:device-chassis device-chassis-label, :ref:sflow-profile sflow-profile-label, :ref:hardware hardware-label, :ref:feature-config feature-config-label, :ref:telemetry-profile telemetry-profile-label, :ref:bgp-router bgp-router-label, :ref:virtual-network virtual-network-label, :ref:virtual-port-group virtual-port-group-label, :ref:loadbalancer-member loadbalancer-member-label, :ref:namespace namespace-label, :ref:feature feature-label, :ref:storm-control-profile storm-control-profile-label, :ref:device-image device-image-label, :ref:physical-interface physical-interface-label, :ref:access-control-list access-control-list-label, :ref:snmp-profile snmp-profile-label, :ref:node node-label, :ref:grpc-profile grpc-profile-label, :ref:customer-attachment customer-attachment-label, :ref:structured-syslog-sla-profile structured-syslog-sla-profile-label, :ref:host-based-service host-based-service-label, :ref:virtual-machine virtual-machine-label, :ref:interface-route-table interface-route-table-label, :ref:service-appliance service-appliance-label, :ref:service-health-check service-health-check-label, :ref:network-ipam network-ipam-label, :ref:api-access-list api-access-list-label, :ref:routing-instance routing-instance-label, :ref:alias-ip-pool alias-ip-pool-label, :ref:data-center-interconnect data-center-interconnect-label

REST API

Fetch a specific tag

GET /tag/{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	TagReadAll
404	Not Found	Error

Update a specific tag

PUT /tag/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	tag optional		TagUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific tag

DELETE /tag/{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 tag

GET /tags

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 tag

POST /tags

Parameters

Type	Name	Description	Schema	Default
body	tag required	Body of tag resource	TagCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific tag-type

GET /tag-type/{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	TagTypeReadAll
404	Not Found	Error

Update a specific tag-type

PUT /tag-type/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	tag-type optional		TagTypeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific tag-type

DELETE /tag-type/{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 tag-type

GET /tag-types

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 tag-type

POST /tag-types

Parameters

Type	Name	Description	Schema	Default
body	tag-type required	Body of tag-type resource	TagTypeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

tag-type

Data Model

Description

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
tag-type-id	Internal Tag type ID coded on 16 bits where the first 255 IDs are reserved and pre-defined. Users (principally cloud admin) can define arbitrary types but its automatically shared to all project as it is a global resource.	True	string	R	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:tag tag-label

REST API

Fetch a specific tag-type

GET /tag-type/{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	TagTypeReadAll
404	Not Found	Error

Update a specific tag-type

PUT /tag-type/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	tag-type optional		TagTypeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific tag-type

DELETE /tag-type/{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 tag-type

GET /tag-types

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 tag-type

POST /tag-types

Parameters

Type	Name	Description	Schema	Default
body	tag-type required	Body of tag-type resource	TagTypeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

telemetry-profile

Data Model

Description

Encapsulates data related to telemetry from network devices like sflow, JTI, gRPC, SNMP etc

Parents: None

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
telemetry-profile-is-default	This attribute indicates whether it is a default telemetry profile or not. Default profiles are non- editable.	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:sflow-profile sflow-profile-label	Sflow profile that this telemetry profile uses. Only one sflow profile can be associated to one telemetry profile.	False	None	CRUD	user
:ref:grpc-profile grpc-profile-label	gRPC profile that this telemetry profile uses. Only one gRPC profile can be associated to one telemetry profile.	False	None	CRUD	user
:ref:netconf-profile netconf-profile-label	netconf profile that this telemetry profile uses. Only one netconf profile can be associated to one telemetry profile.	False	None	CRUD	user
:ref:snmp-profile snmp-profile-label	snmp profile that this telemetry profile uses. Only one snmp profile can be associated to one telemetry profile.	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 telemetry-profile

GET /telemetry-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	TelemetryProfileReadAll
404	Not Found	Error

Update a specific telemetry-profile

PUT /telemetry-profile/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	telemetry-profile optional		TelemetryProfileUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific telemetry-profile

DELETE /telemetry-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 telemetry-profile

GET /telemetry-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 telemetry-profile

POST /telemetry-profiles

Parameters

Type	Name	Description	Schema	Default
body	telemetry-profile required	Body of telemetry-profile resource	TelemetryProfileCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-DNS

Data Model

Description

Virtual DNS server is DNS as service for tenants. It is inbound DNS service for virtual machines in this project. DNS requests by end points inside this project/IPAM are served by this DNS server rules.

Parents: domain

Children

virtual-DNS-record

Properties

Name	Description	Required	Type	Operations	Created By
virtual-DNS-data	Virtual DNS data has configuration for virtual DNS like domain, dynamic records etc.	True	VirtualDnsType	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:network-ipam network-ipam-label

REST API

Fetch a specific virtual-DNS

GET /virtual-DNS/{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	VirtualDnsReadAll
404	Not Found	Error

Update a specific virtual-DNS

PUT /virtual-DNS/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-DNS optional		VirtualDnsUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-DNS

DELETE /virtual-DNS/{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 virtual-DNS

GET /virtual-DNSs

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 virtual-DNS

POST /virtual-DNSs

Parameters

Type	Name	Description	Schema	Default
body	virtual-DNS required	Body of virtual-DNS resource	VirtualDnsCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific virtual-DNS-record

GET /virtual-DNS-record/{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	VirtualDnsRecordReadAll
404	Not Found	Error

Update a specific virtual-DNS-record

PUT /virtual-DNS-record/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-DNS-record optional		VirtualDnsRecordUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-DNS-record

DELETE /virtual-DNS-record/{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 virtual-DNS-record

GET /virtual-DNS-records

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 virtual-DNS-record

POST /virtual-DNS-records

Parameters

Type	Name	Description	Schema	Default
body	virtual-DNS-record required	Body of virtual-DNS-record resource	VirtualDnsRecordCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-DNS-record

Data Model

Description

Static DNS records in virtual DNS server.

Parents: virtual-DNS

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
virtual-DNS-record-data	DNS record data has configuration like type, name, ip address, loadbalancing etc.	True	VirtualDnsRecordType	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 virtual-DNS-record

GET /virtual-DNS-record/{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	VirtualDnsRecordReadAll
404	Not Found	Error

Update a specific virtual-DNS-record

PUT /virtual-DNS-record/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-DNS-record optional		VirtualDnsRecordUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-DNS-record

DELETE /virtual-DNS-record/{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 virtual-DNS-record

GET /virtual-DNS-records

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 virtual-DNS-record

POST /virtual-DNS-records

Parameters

Type	Name	Description	Schema	Default
body	virtual-DNS-record required	Body of virtual-DNS-record resource	VirtualDnsRecordCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-ip

Data Model

Description

Virtual ip object application(protocol, port). Applicable only to LBaaS V1

Parents: project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
virtual-ip-properties	Virtual ip configuration like port, protocol, subnet etc.	True	VirtualIpType	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:loadbalancer-pool loadbalancer-pool-label	Reference to the load balancer pool that this virtual ip represent. Applicable only to LBaaS V1	False	None	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	Reference to the virtual machine interface for virtual ip. Applicable only to LBaaS V1	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 virtual-ip

GET /virtual-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	VirtualIpReadAll
404	Not Found	Error

Update a specific virtual-ip

PUT /virtual-ip/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-ip optional		VirtualIpUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-ip

DELETE /virtual-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 virtual-ip

GET /virtual-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 virtual-ip

POST /virtual-ips

Parameters

Type	Name	Description	Schema	Default
body	virtual-ip required	Body of virtual-ip resource	VirtualIpCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-machine

Data Model

Description

Parents: None

Children

virtual-machine-interface

Properties

Name	Description	Required	Type	Operations	Created By
server-type	An enumeration value specifying the server type.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:service-instance service-instance-label	Reference to the service instance of this virtual machine.	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:virtual-machine-interface virtual-machine-interface-label, :ref:virtual-router virtual-router-label

REST API

Fetch a specific virtual-machine

GET /virtual-machine/{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	VirtualMachineReadAll
404	Not Found	Error

Update a specific virtual-machine

PUT /virtual-machine/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-machine optional		VirtualMachineUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-machine

DELETE /virtual-machine/{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 virtual-machine

GET /virtual-machines

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 virtual-machine

POST /virtual-machines

Parameters

Type	Name	Description	Schema	Default
body	virtual-machine required	Body of virtual-machine resource	VirtualMachineCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Fetch a specific virtual-machine-interface

GET /virtual-machine-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	VirtualMachineInterfaceReadAll
404	Not Found	Error

Update a specific virtual-machine-interface

PUT /virtual-machine-interface/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-machine-interface optional		VirtualMachineInterfaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-machine-interface

DELETE /virtual-machine-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 virtual-machine-interface

GET /virtual-machine-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 virtual-machine-interface

POST /virtual-machine-interfaces

Parameters

Type	Name	Description	Schema	Default
body	virtual-machine-interface required	Body of virtual-machine-interface resource	VirtualMachineInterfaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-machine-interface

Data Model

Description

When parent is virtual-machine,

References to child interfaces this virtual machine has, this is DEPRECATED.

When parent is project,

Virtual machine interface represent a interface(port) into virtual network. It may or may not have corresponding virtual machine. A virtual machine interface has atleast a MAC address and Ip address.

When parent is virtual-router,

An interface on a virtual-router, e.g. vhost0

Parents: virtual-machine, project, virtual-router

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
ecmp-hashing-include-fields	ECMP hashing config at global level.	False	EcmpHashingIncludeFields	CRUD	user
port-security-enabled	Port security status on the network	False	boolean	CRUD	user
virtual-machine-interface-mac-addresses	MAC address of the virtual machine interface, automatically assigned by system if not provided.	True	MacAddressesType	CRUD	user
virtual-machine-interface-dhcp-option-list	DHCP options configuration specific to this interface.	False	DhcpOptionsListType	CRUD	user
virtual-machine-interface-host-routes	List of host routes(prefixes, nexthop) that are passed to VM via DHCP.	False	RouteTableType	CRUD	user
virtual-machine-interface-allowed-address-pairs	List of (IP address, MAC) other than instance ip on this interface.	False	AllowedAddressPairs	CRUD	user
vrf-assign-table	VRF assignment policy for this interface, automatically generated by system.	False	VrfAssignTableType	CRUD	system
virtual-machine-interface-device-owner	For openstack compatibility, not used by system.	False	string	CRUD	user
virtual-machine-interface-disable-policy	When True all policy checks for ingress and egress traffic from this interface are disabled. Flow table entries are not created. Features that require policy will not work on this interface, these include security group, floating IP, service chain, linklocal services.	False	boolean	CRUD	user
virtual-machine-interface-properties	Virtual Machine Interface miscellaneous configurations.	False	VirtualMachineInterfacePropertiesType	CRUD	user
virtual-machine-interface-bindings	Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.	False	KeyValuePairs	CRUD	user
virtual-machine-interface-fat-flow-protocols	List of (protocol, port number), for flows to interface with (protocol, destination port number), vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow. Hence many flows will map to single flow.	False	FatFlowProtocols	CRUD	user
vlan-tag-based-bridge-domain	Enable VLAN tag based bridge domain classification on the port	False	boolean	CRUD	user
igmp-enable	IGMP mode at Global level.	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:security-logging-object security-logging-object-label	Reference to security logging object for this virtual machine interface	False	None	CRUD	user
:ref:qos-config qos-config-label	Reference to QoS config for this virtual machine interface.	False	None	CRUD	user
:ref:security-group security-group-label	Interface ACL, Automatically generated by system based on security groups attached to this interface.	False	None	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	List of references to the sub interfaces of this interface.	False	None	CRUD	user
:ref:virtual-machine virtual-machine-label	This interface belongs to the referenced virtual machine.	False	None	CRUD	user
:ref:virtual-network virtual-network-label	This interface is member of the referenced virtual network.	True	None	CRUD	user
:ref:routing-instance routing-instance-label	Automatically generated Forwarding policy. This will be deprecated in future in favour of VRF assign rules.	False	PolicyBasedForwardingRuleType	CRUD	system
:ref:bgp-router bgp-router-label	Reference to bgp-router from the virtual machine interface.	True	None	CRUD	user
:ref:port-tuple port-tuple-label	Ordered set of references to the interfaces in this port tuple. Order is same as specified in the service interface. example (left, right, management, other1).	False	None	CRUD	user
:ref:service-health-check service-health-check-label	Reference to health check object attached to this interface.	False	None	CRUD	user
:ref:interface-route-table interface-route-table-label	Reference to the interface route table attached to this interface.	False	None	CRUD	user
:ref:physical-interface physical-interface-label	Reference to the physical interface of service appliance this service interface represents.	False	None	CRUD	system
:ref:bridge-domain bridge-domain-label	Virtual Machine interface maps to a bridge-domain by defaultor based on in coming 802.1Q vlan tag	False	BridgeDomainMembershipType	CRUD	user
:ref:service-endpoint service-endpoint-label	Links the access endpoint i.e virtual-machine-interface to service endpoint.	False	None	CRUD	user
:ref:virtual-port-group virtual-port-group-label	virtual port group to which this virtaul machine interface is attached	False	VMIVirtualPortGroupAttributes	CRUD	user
:ref:port-profile port-profile-label	Port profiles attached to this virtual machine 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:bgp-as-a-service bgp-as-a-service-label, :ref:subnet subnet-label, :ref:virtual-port-group virtual-port-group-label, :ref:instance-ip instance-ip-label, :ref:customer-attachment customer-attachment-label, :ref:logical-interface logical-interface-label, :ref:floating-ip floating-ip-label, :ref:alias-ip alias-ip-label, :ref:link-aggregation-group link-aggregation-group-label, :ref:virtual-ip virtual-ip-label, :ref:loadbalancer-pool loadbalancer-pool-label, :ref:loadbalancer loadbalancer-label, :ref:logical-router logical-router-label

REST API

Fetch a specific virtual-machine-interface

GET /virtual-machine-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	VirtualMachineInterfaceReadAll
404	Not Found	Error

Update a specific virtual-machine-interface

PUT /virtual-machine-interface/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-machine-interface optional		VirtualMachineInterfaceUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-machine-interface

DELETE /virtual-machine-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 virtual-machine-interface

GET /virtual-machine-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 virtual-machine-interface

POST /virtual-machine-interfaces

Parameters

Type	Name	Description	Schema	Default
body	virtual-machine-interface required	Body of virtual-machine-interface resource	VirtualMachineInterfaceCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-network

Data Model

Description

Virtual network is collection of end points (interface or ip(s) or MAC(s)) that can talk to each other by default. It is collection of subnets connected by implicit router which default gateway in each subnet.

Parents: project

Children

access-control-list, alias-ip-pool, bridge-domain, floating-ip-pool, routing-instance

Properties

Name	Description	Required	Type	Operations	Created By
ecmp-hashing-include-fields	ECMP hashing config at global level.	False	EcmpHashingIncludeFields	CRUD	user
virtual-network-category	This attribute is to differentiate the infrastructure networks from the tenant and routed networks. Infra-networks could be in-band network for management and control traffic	False	string	CRUD	user
virtual-network-properties	Virtual network miscellaneous configurations.	False	VirtualNetworkType	CRUD	user
virtual-network-routed-properties	Attributes for routed virtual networks.	False	VirtualNetworkRoutedPropertiesType	CRUD	user
provider-properties	Virtual network is provider network. Specifies VLAN tag and physical network name.	False	ProviderDetails	CRD	user
virtual-network-network-id	System assigned unique 32 bit ID for every virtual network.	False	number	CR	system
is-provider-network	provider network status of the virtual-network.	False	boolean	R	user
port-security-enabled	Port security status on the network	False	boolean	CRUD	user
fabric-snat	Provide connectivity to underlay network by port mapping	False	boolean	CRUD	user
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
router-external	When true, this virtual network is openstack router external network.	False	boolean	CRUD	user
is-shared	When true, this virtual network is shared with all tenants.	False	boolean	CRUD	user
mtu	MTU attribute for the virtual network	False	number	CRUD	user
external-ipam	IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only feature.	False	boolean	CRUD	user
flood-unknown-unicast	When true, packets with unknown unicast MAC address are flooded within the network. Default they are dropped.	False	boolean	CRUD	user
multi-policy-service-chains-enabled	Allow multiple service chains within same two networks based on network policy. Current limitation is that both networks must reside within cluster, except when right most service is NAT.	False	boolean	CRUD	user
address-allocation-mode	Address allocation mode for virtual network.	False	string	CRUD	user
virtual-network-fat-flow-protocols	Fat flow configuration which is a list, will be applied to all the interfaces in the specified virtual-network	False	FatFlowProtocols	CRUD	user
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
pbb-evpn-enable	Enable/Disable PBB EVPN tunneling on the network	False	boolean	CRUD	user
pbb-etree-enable	Enable/Disable PBB ETREE mode on the network	False	boolean	CRUD	user
layer2-control-word	Enable/Disable adding control word to the Layer 2 encapsulation	False	boolean	CRUD	user
igmp-enable	IGMP mode at Global level.	False	boolean	CRUD	user
mac-ip-learning-enable	Enable/Disable MAC-IP Learning on the network	False	boolean	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:security-logging-object security-logging-object-label	Reference to security logging object for this virtual network.	False	None	CRUD	user
:ref:qos-config qos-config-label	Reference to QoS configuration for this virtual network.	False	None	CRUD	user
:ref:network-ipam network-ipam-label	Reference to network-ipam this network is using. It has list of subnets that are to be used as property of the reference.	True	VnSubnetsType	CRUD	user
:ref:network-policy network-policy-label	Reference to network-policy attached to this network. It has sequence number to specify attachment order.	False	VirtualNetworkPolicyType	CRUD	user
:ref:virtual-network virtual-network-label	Reference to a virtual network which is the provider network for the given virtual network. Traffic forwarding happens in the routing instance of the provider network.	False	None	CRUD	user
:ref:service-health-check service-health-check-label	Reference to health check object attached to VN object, used to enable BFD health check over MAC IP Learnt IP Addresses of VN.	False	None	CRUD	user
:ref:route-table route-table-label	Reference to route table attached to this virtual network.	False	None	CRUD	user
:ref:multicast-policy multicast-policy-label	Reference to multicast policy. Each multicast policy has a list of (S,G) Addresses.	False	None	CRUD	user
:ref:bgpvpn bgpvpn-label	Back reference to virtual network associated to the BGP VPN resource	False	None	CRUD	user
:ref:intent-map intent-map-label	All virtual-network objects that get created in the fabric	False	None	CRUD	user
:ref:routing-policy routing-policy-label	List of references of routing policy objects. imported by user.	False	RoutingPolicyType	CRUD	user
:ref:tag tag-label	Tag attached to an object - has a type and value	False	None	CRUD	user

Back References

:ref:fabric fabric-label, :ref:port-tuple port-tuple-label, :ref:instance-ip instance-ip-label, :ref:host-based-service host-based-service-label, :ref:physical-router physical-router-label, :ref:logical-router logical-router-label, :ref:flow-node flow-node-label, :ref:virtual-machine-interface virtual-machine-interface-label, :ref:firewall-rule firewall-rule-label, :ref:data-center-interconnect data-center-interconnect-label

REST API

Fetch a specific virtual-network

GET /virtual-network/{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	VirtualNetworkReadAll
404	Not Found	Error

Update a specific virtual-network

PUT /virtual-network/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-network optional		VirtualNetworkUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-network

DELETE /virtual-network/{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 virtual-network

GET /virtual-networks

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 virtual-network

POST /virtual-networks

Parameters

Type	Name	Description	Schema	Default
body	virtual-network required	Body of virtual-network resource	VirtualNetworkCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-port-group

Data Model

Description

When parent is fabric,

List of virtual port groups in this fabric.

When parent is project,

List of virtual port groups/trunk ports in this project.

Parents: fabric, project

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
virtual-port-group-lacp-enabled	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	True	boolean	CRUD	user
virtual-port-group-trunk-port-id	id of the port that enables multi valn trunking.	True	string	CR	user
virtual-port-group-user-created	Flag to be set to True when its externally created and False when created internally. Default is set to True	False	boolean	CRUD	user
virtual-port-group-type	Type of Virtual port group. It can be either access i.e L2 connectivity or routed.	False	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:physical-interface physical-interface-label	All the physical interfaces that belong to this link aggregation group. The physical interface could belong to the same or different physical router	False	VpgInterfaceParametersType	CRUD	user
:ref:virtual-machine-interface virtual-machine-interface-label	list of virtual machine interfaces that are part of this virtual port group	False	None	CRUD	user
:ref:security-group security-group-label	Interface ACL, automatically generated by system based on security groups attached to this virtual port group.	False	None	CRUD	user
:ref:port-profile port-profile-label	Port profiles attached to this virtual port 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:virtual-machine-interface virtual-machine-interface-label

REST API

Fetch a specific virtual-port-group

GET /virtual-port-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	VirtualPortGroupReadAll
404	Not Found	Error

Update a specific virtual-port-group

PUT /virtual-port-group/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-port-group optional		VirtualPortGroupUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-port-group

DELETE /virtual-port-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 virtual-port-group

GET /virtual-port-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 virtual-port-group

POST /virtual-port-groups

Parameters

Type	Name	Description	Schema	Default
body	virtual-port-group required	Body of virtual-port-group resource	VirtualPortGroupCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

virtual-router

Data Model

Description

Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s), routers.

Parents: global-system-config

Children

virtual-machine-interface

Properties

Name	Description	Required	Type	Operations	Created By
virtual-router-type	Different types of the vrouters in the system.	False	string	CRD	user
virtual-router-dpdk-enabled	This vrouter’s data path is using DPDK library, Virtual machines interfaces scheduled on this compute node will be tagged with additional flags so that they are spawned with user space virtio driver. It is only applicable for embedded vrouter.	False	boolean	CRUD	user
virtual-router-sriov-physical-networks	Dictionary of (physnet, interface) mapping for this virtual router.	False	KeyValuePairs	CRUD	user
virtual-router-ip-address	Ip address of the virtual router.	True	string	CRUD	user

References

To	Description	Required	Type	Operations	Created By
:ref:network-ipam network-ipam-label	Reference to network-ipam this virtual-router is using. It has list of virtual-router specific allocation-pools and cidrs that are to be used as property of the reference.	False	VirtualRouterNetworkIpamType	CRUD	user
:ref:sub-cluster sub-cluster-label	Reference of vrouter to sub-cluster.	False	None	CRUD	user
:ref:virtual-machine virtual-machine-label	References to all virtual machines on this vrouter. This link is not present for dynamically scheduled VMs by Nova.	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, :ref:instance-ip instance-ip-label, :ref:provider-attachment provider-attachment-label

REST API

Fetch a specific virtual-router

GET /virtual-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	VirtualRouterReadAll
404	Not Found	Error

Update a specific virtual-router

PUT /virtual-router/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	virtual-router optional		VirtualRouterUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific virtual-router

DELETE /virtual-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 virtual-router

GET /virtual-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 virtual-router

POST /virtual-routers

Parameters

Type	Name	Description	Schema	Default
body	virtual-router required	Body of virtual-router resource	VirtualRouterCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

webui-node

Data Model

Description

WebUI node is object representing a logical node in system which hosts the Contrail UI.

Parents: global-system-config

Children

None

Properties

Name	Description	Required	Type	Operations	Created By
webui-node-ip-address	Ip address of the webui 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 webui-node

GET /webui-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	WebuiNodeReadAll
404	Not Found	Error

Update a specific webui-node

PUT /webui-node/{id}

Parameters

Type	Name	Description	Schema	Default
path	id required	The id of resource
body	webui-node optional		WebuiNodeUpdate

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Delete a specific webui-node

DELETE /webui-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 webui-node

GET /webui-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 webui-node

POST /webui-nodes

Parameters

Type	Name	Description	Schema	Default
body	webui-node required	Body of webui-node resource	WebuiNodeCreate

Responses

HTTP Code	Description	Schema
200	Success	Uuid

Generic REST API

Find resource id given its type and fqname

POST /fqname-to-id

Parameters

Type	Name	Description	Schema	Default
body	type required		string
body	fq_name required	Fully Qualified Name of resource	< string > array

Responses

HTTP Code	Description	Schema
200	Success	Uuid
404	Not Found	Error

Find type and fqname given resource id

POST /id-to-fqname

Parameters

Type	Name	Description	Schema	Default
body	uuid required		string

Responses

HTTP Code	Description	Schema
200	Success	TypeFQName
404	Not Found	Error

Definitions

Error

Name	Description	Schema
message required		string

Uuid

Name	Description	Schema
uuid required		string

TypeFQName

Name	Description	Schema
type required		string
fq_name required	Fully Qualified Name of resource	< string > array

ResourceListSummary

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
uuid required		string
href required		string

MacAddressesType

Name	Description	Schema
mac_address optional		string

IpAddressesType

Name	Description	Schema
ip_address optional	String of standard notation of ipv4 or ipv6 address	string

SubnetType

Name	Description	Schema
ip_prefix optional		string
ip_prefix_len optional		integer

VirtualRouterNetworkIpamType

Name	Description	Schema
allocation_pools optional	List of ranges of ip address for vrouter specific allocation	AllocationPoolType
subnet optional	List of ip prefix and length for vrouter specific subnets	SubnetType

AllowedAddressPairs

Name	Description	Schema
allowed_address_pair optional		AllowedAddressPair

VirtualNetworkPolicyType

Name	Description	Schema
sequence optional	Sequence number to specify order of policy attachment to network	SequenceType
timer optional	Timer to specify when the policy can be active	TimerType

PortMappings

Name	Description	Schema
port_mappings optional		PortMap

ActionListType

Name	Description	Schema
simple_action required	Simple allow(pass) or deny action for traffic matching this rule	Any of [‘deny’, ‘pass’]
gateway_name optional	For internal use only	string
apply_service optional	Ordered list of service instances in service chain applied to traffic matching the rule	string
service_properties optional	Properties of the service-policy if action is apply-service	ServicePropertiesType
mirror_to optional	Mirror traffic matching this rule	MirrorActionType
assign_routing_instance optional	For internal use only	string
log optional	Flow records for traffic matching this rule are sent at higher priority	boolean
alert optional	For internal use only	boolean
qos_action optional	FQN of Qos configuration object for QoS marking	string
host_based_service optional	Forward traffic matching this rule to the project’s host based service	boolean

AclEntriesType

Name	Description	Schema
dynamic optional	For Internal use only	boolean
acl_rule required	For Internal use only	AclRuleType

PolicyEntriesType

Name	Description	Schema
policy_rule required	List of policy rules	PolicyRuleType

DhcpOptionsListType

Name	Description	Schema
dhcp_option optional	List of DHCP options	DhcpOptionType

DeviceFamilyListType

Name	Description	Schema
device_family optional		string

VendorHardwaresType

Name	Description	Schema
vendor_hardware optional		string

IpamType

Name	Description	Schema
ipam_method optional		Any of [‘dhcp’, ‘fixed’]
ipam_dns_method optional		Any of [‘none’, ‘default-dns-server’, ‘tenant-dns-server’, ‘virtual-dns-server’]
ipam_dns_server optional		IpamDnsAddressType
dhcp_option_list optional		DhcpOptionsListType
cidr_block optional		SubnetType
host_routes optional		RouteTableType

EncapsulationPrioritiesType

Name	Description	Schema
encapsulation optional	Ordered list of encapsulation types to be used in priority	Any of [‘MPLSoGRE’, ‘MPLSoUDP’, ‘VXLAN’]

LinklocalServicesTypes

Name	Description	Schema
linklocal_service_entry optional	List of link local services	LinklocalServiceEntryType

VirtualDnsType

Name	Description	Schema
domain_name required	Default domain name for this virtual DNS server	string
dynamic_records_from_client optional	Allow automatic addition of records on VM launch, default is True	boolean
record_order optional	Order of DNS load balancing, fixed, random, round-robin. Default is random	Any of [‘fixed’, ‘random’, ‘round-robin’]
default_ttl_seconds optional	Default Time To Live for DNS records	integer
next_virtual_DNS optional	Next virtual DNS server to lookup if record is not found. Default is proxy to infrastructure DNS	string
floating_ip_record optional	Decides how floating ip records are added	Any of [‘dashed-ip’, ‘dashed-ip-tenant-name’, ‘vm-name’, ‘vm-name-tenant-name’]
external_visible optional	Currently this option is not supported	boolean
reverse_resolution optional	Allow reverse DNS resolution, ip to name mapping	boolean
soa_record optional	Dns soa record values	DnsSoaRecordType

VirtualDnsRecordType

Name	Description	Schema
record_name required	DNS name to be resolved	string
record_type optional	DNS record type can be A, AAAA, CNAME, PTR, NS and MX	Any of [‘A’, ‘AAAA’, ‘CNAME’, ‘PTR’, ‘NS’, ‘MX’]
record_class optional	DNS record class supported is IN	Any of [‘IN’]
record_data required	DNS record data is either ip address or string depending on type	string
record_ttl_seconds optional	Time To Live for this DNS record	integer
record_mx_preference optional		integer
record_source_name optional	name of the compute node which sends add for A type or PTR type dns record for vm	string

FloatingIpPoolSubnetType

Name	Description	Schema
subnet_uuid optional	List of subnets associated with this floating ip pool.	string

VnSubnetsType

Name	Description	Schema
ipam_subnets optional		IpamSubnetType
host_routes optional	Common host routes to be sent via DHCP for VM(s) in all the subnets, Next hop for these routes is always default gateway	RouteTableType

RbacRuleEntriesType

Name	Description	Schema
rbac_rule optional		RbacRuleType

DomainLimitsType

Name	Description	Schema
project_limit optional	Maximum number of projects allowed in this domain	integer
virtual_network_limit optional	Maximum number of virtual networks allowed in this domain	integer
security_group_limit optional	Maximum number of security groups allowed in this domain	integer

PluginProperties

Name	Description	Schema
plugin_property optional	List of plugin specific properties (property, value)	PluginProperty

QuotaType

Name	Description	Schema
defaults optional	Need to clarify	integer
floating_ip optional	Maximum number of floating ips	integer
instance_ip optional	Maximum number of instance ips	integer
virtual_machine_interface optional	Maximum number of virtual machine interfaces	integer
virtual_network optional	Maximum number of virtual networks	integer
virtual_router optional	Maximum number of logical routers	integer
virtual_DNS optional	Maximum number of virtual DNS servers	integer
virtual_DNS_record optional	Maximum number of virtual DNS records	integer
bgp_router optional	Maximum number of bgp routers	integer
network_ipam optional	Maximum number of network IPAMs	integer
access_control_list optional	Maximum number of access control lists	integer
network_policy optional	Maximum number of network policies	integer
floating_ip_pool optional	Maximum number of floating ip pools	integer
service_template optional	Maximum number of service templates	integer
service_instance optional	Maximum number of service instances	integer
logical_router optional	Maximum number of logical routers	integer
security_group optional	Maximum number of security groups	integer
security_group_rule optional	Maximum number of security group rules	integer
subnet optional	Maximum number of subnets	integer
global_vrouter_config optional	Maximum number of global vrouter configs	integer
loadbalancer optional	Maximum number of loadbalancers	integer
loadbalancer_listener optional	Maximum number of loadbalancer listeners	integer
loadbalancer_pool optional	Maximum number of loadbalancer pools	integer
loadbalancer_member optional	Maximum number of loadbalancer member	integer
loadbalancer_healthmonitor optional	Maximum number of loadbalancer health monitors	integer
virtual_ip optional	Maximum number of virtual ips	integer
security_logging_object optional	Maximum number of security logging objects	integer
route_table optional	Maximum number of route tables	integer
firewall_group optional	Maximum number of application policy set	integer
firewall_policy optional	Maximum number of firewall policy	integer
firewall_rule optional	Maximum number of firewall rule	integer
host_based_service optional	Maximum number of host based service. Actually limited to 0 or 1 for a project (can not be unlimited or more than 1)	integer

FlowAgingTimeoutList

Name	Description	Schema
flow_aging_timeout optional	List of (ip protocol, port number, timeout in seconds)	FlowAgingTimeout

QosIdForwardingClassPairs

Name	Description	Schema
qos_id_forwarding_class_pair optional		QosIdForwardingClassPair

ControlTrafficDscpType

Name	Description	Schema
control optional	DSCP value for control protocols traffic	integer
analytics optional	DSCP value for traffic towards analytics	integer
dns optional	DSCP value for DNS traffic	integer

GracefulRestartParametersType

Name	Description	Schema
enable optional	Enable/Disable knob for all GR parameters to take effect	boolean
restart_time optional	Time (in seconds) taken by the restarting speaker to get back to stable state	integer
long_lived_restart_time optional	Extended Time (in seconds) taken by the restarting speaker after restart-time to get back to stable state	integer
end_of_rib_timeout optional	Maximum time (in seconds) to wait for EndOfRib reception/transmission	integer
bgp_helper_enable optional	Enable GR Helper mode for BGP peers in contrail-control	boolean
xmpp_helper_enable optional	Enable GR Helper mode for XMPP peers (agents) in contrail-control	boolean

FastConvergenceParametersType

Name	Description	Schema
enable optional	Enable/Disable knob for all Fast-Convergence parameters to take effect	boolean
nh_reachability_check optional	Enable next-hop reachability checks in control plane for routes in underlay for faster convergence	boolean
xmpp_hold_time optional	The negotiated XMPP hold-time (in seconds) for sessions between the control and data plane	integer

PortTranslationPools

Name	Description	Schema
port_translation_pool optional		PortTranslationPool

BGPaaSControlNodeZoneAttributes

Name	Description	Schema
bgpaas_control_node_zone_type optional	Specifies BGPaaSControlNodeZoneType. If bgpaas uses x.x.x.1 ip for peering, BGPaaSControlNodeZoneType should be set to primary. If it is x.x.x.2 ip for peering, BGPaaSControlNodeZoneType should be secondary	Any of [‘primary’, ‘secondary’]

BGPaaServiceParametersType

Name	Description	Schema
port_start optional		integer
port_end optional		integer

SecurityLoggingObjectRuleListType

Name	Description	Schema
rule optional	List of rules along with logging rate for each rule. Both rule-uuid and rate are optional. When rule-uuid is absent then it means all rules of associated SG or network-policy	SecurityLoggingObjectRuleEntryType

EcmpHashingIncludeFields

Name	Description	Schema
hashing_configured optional	When True, Packet header fields used in calculating ECMP hash is decided by following flags	boolean
source_ip optional	When false, do not use source ip in the ECMP hash calculation	boolean
destination_ip optional	When false, do not use destination ip in the ECMP hash calculation	boolean
ip_protocol optional	When false, do not use ip protocol in the ECMP hash calculation	boolean
source_port optional	When false, do not use source port in the ECMP hash calculation	boolean
destination_port optional	When false, do not use destination port in the ECMP hash calculation	boolean

EncryptionTunnelEndpointList

Name	Description	Schema
endpoint optional	Tunnel endpoint remote address	EncryptionTunnelEndpoint

VirtualNetworkRoutedPropertiesType

Name	Description	Schema
routed_properties optional	List of routed properties for virtual network.	RoutedProperties
shared_across_all_lrs optional	Allow sharing of this routed virtual network across all LR’s in the system.	boolean

VirtualNetworkType

Name	Description	Schema
allow_transit optional	Enables transitive property for route imports. If B imports routes of A and C imports from B, then if B is transitive then C will have routes from A.	boolean
network_id optional	Not currently in used	integer
vxlan_network_identifier required	VxLAN VNI value for this network	integer
forwarding_mode optional	Packet forwarding mode for this virtual network	Any of [‘l2_l3’, ‘l2’, ‘l3’]
rpf optional	Flag used to disable Reverse Path Forwarding(RPF) check for this network	Any of [‘enable’, ‘disable’]
mirror_destination optional	Flag to mark the virtual network as mirror destination network	boolean
max_flows optional	Maximum number of flows permitted on each VMI of the VN	integer
mtu optional	MTU value for this network	integer

ProviderDetails

Name	Description	Schema
segmentation_id optional		integer
physical_network optional		string

RouteTargetList

Name	Description	Schema
route_target optional		string

IpamSubnets

Name	Description	Schema
subnets optional		IpamSubnetType

VrfAssignTableType

Name	Description	Schema
vrf_assign_rule optional		VrfAssignRuleType

ServiceInterfaceTag

Name	Description	Schema
interface_type optional		string

RoutingPolicyServiceInstanceType

Name	Description	Schema
left_sequence optional		string
right_sequence optional		string

VirtualMachineInterfacePropertiesType

Name	Description	Schema
service_interface_type optional	This interface belongs to Service Instance and is tagged as left, right or other	string
interface_mirror optional	Interface Mirror configuration	InterfaceMirrorType
local_preference optional	BGP route local preference for routes representing this interface, higher value is higher preference	integer
sub_interface_vlan_tag optional	802.1Q VLAN tag to be used if this interface is sub-interface for some other interface.	integer
max_flows optional	Maximum number of flows permitted on VMI	integer

FatFlowProtocols

Name	Description	Schema
fat_flow_protocol optional		ProtocolType

PolicyBasedForwardingRuleType

Name	Description	Schema
direction optional		Any of [‘ingress’, ‘egress’, ‘both’]
vlan_tag optional		integer
src_mac optional		string
dst_mac optional		string
mpls_label optional		integer
service_chain_address optional		string
ipv6_service_chain_address optional	String of standard notation of ipv4 or ipv6 address	string
protocol optional		string

JunosServicePorts

Name	Description	Schema
service_port optional		string

ServiceTemplateType

Name	Description	Schema
version optional	Version of service template. 1: Service virtual machines and interfaces are automatically launched, monitored and deleted. 2: User creates all objects( virtual machines and interfaces) and manages the life cycle. Useful when virtual machines and interfaces are managed via heat template	integer
service_mode required	Service instance mode decides how packets are forwarded across the service	Any of [‘transparent’, ‘in-network’, ‘in-network-nat’]
service_type required	Service instance mode decides how routing happens across the service	Any of [‘firewall’, ‘analyzer’, ‘source-nat’, ‘loadbalancer’]
image_name optional	Glance image name for the service virtual machine, Version 1 only	string
service_scaling optional	Enable scaling of service virtual machines, Version 1 only	boolean
interface_type required	List of interfaces which decided number of interfaces and type	ServiceTemplateInterfaceType
flavor optional	Nova flavor used for service virtual machines, Version 1 only	string
ordered_interfaces optional	Deprecated	boolean
service_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
availability_zone_enable optional	Enable availability zone for version 1 service instances	boolean
vrouter_instance_type optional	Mechanism used to spawn service instance, when vrouter is spawning instances.Allowed values libvirt-qemu, docker or netns	Any of [‘libvirt-qemu’, ‘docker’]
instance_data optional	Opaque string (typically in json format) used to spawn a vrouter-instance.	string

ServiceInstanceType

Name	Description	Schema
auto_policy optional	Set when system creates internal service chains, example SNAT with router external flag in logical router	boolean
availability_zone optional	Availability zone used to spawn VM(s) for this service instance, used in version 1 (V1) only	string
management_virtual_network optional	Deprecated	string
left_virtual_network optional	Deprecated	string
left_ip_address optional	Deprecated	string
right_virtual_network optional	Deprecated	string
right_ip_address optional	Deprecated	string
interface_list required	List of service instance interface properties. Ordered list as per service template	ServiceInstanceInterfaceType
scale_out optional	Number of virtual machines in this service instance, used in version 1 (V1) only	ServiceScaleOutType
ha_mode optional	When scale-out is greater than one, decides if active-active or active-backup, used in version 1 (V1) only	Any of [‘active-active’, ‘active-standby’]
virtual_router_id optional	UUID of a virtual-router on which this service instance need to spawn. Used to spawn services on CPE device when Nova is not present	string
service_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]

RouteTableType

Name	Description	Schema
route optional	List of ip routes with following fields.	RouteType

ServiceHealthCheckType

Name	Description	Schema
enabled optional	Administratively enable or disable this health check.	boolean
health_check_type required	Health check type, currently only link-local, end-to-end and segment are supported	Any of [‘link-local’, ‘end-to-end’, ‘segment’, ‘vn-ip-list’]
monitor_type required	Protocol used to monitor health, currently only HTTP, ICMP(ping), and BFD are supported	Any of [‘PING’, ‘HTTP’, ‘BFD’]
delay required	Time in seconds at which health check is repeated	integer
delayUsecs optional	Time in micro seconds at which health check is repeated	integer
timeout required	Time in seconds to wait for response	integer
timeoutUsecs optional	Time in micro seconds to wait for response	integer
max_retries required	Number of failures before declaring health bad	integer
http_method optional	In case monitor protocol is HTTP, type of http method used like GET, PUT, POST etc	string
url_path optional	In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address	string
expected_codes optional	In case monitor protocol is HTTP, expected return code for HTTP operations like 200 ok.	string
target_ip_all optional	Run BFD for all IP Addresses learnt by mac-ip learning, when enabled.	boolean
target_ip_list optional	Any address that belongs to the list has to run BFD health check when target-ip- all is false.	IpAddressesType

LogicalRouterVirtualNetworkType

Name	Description	Schema
logical_router_virtual_network_type optional		Any of [‘ExternalGateway’, ‘InternalVirtualNetwork’, ‘NAPTSourcePool’]

KeyValuePairs

Name	Description	Schema
key_value_pair optional		KeyValuePair

ServiceApplianceInterfaceType

Name	Description	Schema
interface_type optional		string

DiscoveryServiceAssignmentType

Name	Description	Schema
publisher required	Publisher set	DiscoveryPubSubEndPointType
subscriber required	subscriber set	DiscoveryPubSubEndPointType

MACLimitControlType

Name	Description	Schema
mac_limit required	Number of MACs that can be learnt	integer
mac_limit_action optional	Action to be taken when MAC limit exceeds	Any of [‘log’, ‘alarm’, ‘shutdown’, ‘drop’]

MACMoveLimitControlType

Name	Description	Schema
mac_move_limit required	Number of MAC moves permitted in mac move time window	integer
mac_move_time_window required	MAC move time window	integer
mac_move_limit_action optional	Action to be taken when MAC move limit exceeds	Any of [‘log’, ‘alarm’, ‘shutdown’, ‘drop’]

BridgeDomainMembershipType

Name	Description	Schema
vlan_tag optional	VLAN tag of the incoming packet that maps the virtual- machine-interface to bridge domain	integer

AutonomousSystemsType

Name	Description	Schema
asn optional		integer

MulticastSourceGroups

Name	Description	Schema
multicast_source_group optional		MulticastSourceGroup

TelemetryStateInfo

Name	Description	Schema
resource optional		TelemetryResourceInfo
server_ip optional		string
server_port optional		integer

LoadbalancerPoolType

Name	Description	Schema
status optional	Operating status for this loadbalancer pool.	string
status_description optional	Operating status description for this loadbalancer pool.	string
admin_state optional	Administrative up or down	boolean
protocol optional	IP protocol string like http, https or tcp.	Any of [‘HTTP’, ‘HTTPS’, ‘TCP’, ‘UDP’, ‘TERMINATED_HTTPS’]
loadbalancer_method optional	Load balancing method ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP	Any of [‘ROUND_ROBIN’, ‘LEAST_CONNECTIONS’, ‘SOURCE_IP’]
subnet_id optional	UUID of the subnet from where the members of the pool are reachable.	string
session_persistence optional	Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.	Any of [‘SOURCE_IP’, ‘HTTP_COOKIE’, ‘APP_COOKIE’]
persistence_cookie_name optional	To Be Added	string

LoadbalancerMemberType

Name	Description	Schema
admin_state optional	Administrative up or down.	boolean
status optional	Operational status of the member.	string
status_description optional	Operational status description of the member.	string
protocol_port optional	Destination port for the application on the member.	integer
weight optional	Weight for load balancing	integer
address optional	Ip address of the member	string
subnet_id optional	UUID of the subnet from where the members are reachable.	string

LoadbalancerHealthmonitorType

Name	Description	Schema
admin_state optional	Administratively up or dowm.	boolean
monitor_type required	Protocol used to monitor health, PING, HTTP, HTTPS or TCP	Any of [‘PING’, ‘TCP’, ‘HTTP’, ‘HTTPS’]
delay required	Time in seconds at which health check is repeated	integer
timeout required	Time in seconds to wait for response	integer
max_retries required	Number of failures before declaring health bad	integer
http_method optional	In case monitor protocol is HTTP, type of http method used like GET, PUT, POST etc	string
url_path optional	In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address	string
expected_codes optional	In case monitor protocol is HTTP, expected return code for HTTP operations like 200 ok.	string

VirtualIpType

Name	Description	Schema
address optional	IP address automatically allocated by system.	string
status optional	Operating status for this virtual ip.	string
status_description optional	Operating status description this virtual ip.	string
admin_state optional	Administrative up or down.	boolean
protocol optional	IP protocol string like http, https or tcp.	Any of [‘HTTP’, ‘HTTPS’, ‘TCP’, ‘UDP’, ‘TERMINATED_HTTPS’]
protocol_port optional	Layer 4 protocol destination port.	integer
connection_limit optional	Maximum number of concurrent connections	integer
subnet_id optional	UUID of subnet in which to allocate the Virtual IP.	string
persistence_cookie_name optional	Set this string if the relation of client and server(pool member) need to persist.	string
persistence_type optional	Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.	Any of [‘SOURCE_IP’, ‘HTTP_COOKIE’, ‘APP_COOKIE’]

LoadbalancerListenerType

Name	Description	Schema
protocol optional		Any of [‘HTTP’, ‘HTTPS’, ‘TCP’, ‘UDP’, ‘TERMINATED_HTTPS’]
protocol_port optional		integer
admin_state optional		boolean
connection_limit optional		integer
default_tls_container optional		string
sni_containers optional		string

LoadbalancerType

Name	Description	Schema
status optional	Operational status of the load balancer updated by system.	string
provisioning_status optional	Provisioning status of the load balancer updated by system.	string
operating_status optional	Operational status of the load balancer updated by system.	string
vip_subnet_id optional	Subnet UUID of the subnet of VIP, representing virtual network.	string
vip_address optional	Virtual ip for this LBaaS	string
admin_state optional	Administrative up or down	boolean

AlarmOrList

Name	Description	Schema
or_list optional		AlarmAndList

UveKeysType

Name	Description	Schema
uve_key required	List of UVE tables where this alarm config should be applied	string

UserDefinedLogStatList

Name	Description	Schema
statlist optional		UserDefinedLogStat

SloRateType

Name	Description	Schema
rate optional	Rate at which sessions are logged	integer

SubnetListType

Name	Description	Schema
subnet optional		SubnetType

FirewallServiceType

Name	Description	Schema
protocol optional	Layer 4 protocol in ip packet	string
protocol_id optional	Layer 4 protocol id in ip packet	integer
src_ports optional	Range of source port for layer 4 protocol	PortType
dst_ports optional	Range of destination port for layer 4 protocol	PortType

FirewallServiceGroupType

Name	Description	Schema
firewall_service required		FirewallServiceType

FirewallRuleEndpointType

Name	Description	Schema
subnet optional	Any workload that belongs to this subnet	SubnetType
virtual_network optional	Any workload that belongs to this virtual network	string
address_group optional	Any workload with interface in this address-group	string
tags optional	Any workload with tags matching tags in this list	string
tag_ids optional	Any workload with tags ids matching all the tags ids in this list	integer
any optional	Match any workload	boolean

FirewallRuleMatchTagsType

Name	Description	Schema
tag_list required		string

FirewallRuleMatchTagsTypeIdList

Name	Description	Schema
tag_type required		integer

FirewallSequence

Name	Description	Schema
sequence required		string

ExecutableInfoListType

Name	Description	Schema
executable_info optional		ExecutableInfoType

PlaybookInfoListType

Name	Description	Schema
playbook_info optional		PlaybookInfoType

VpgInterfaceParametersType

Name	Description	Schema
ae_num optional		integer

DeviceCredentialList

Name	Description	Schema
device_credential optional		DeviceCredential

CliDiffListType

Name	Description	Schema
commit_diff_info optional		CliDiffInfoType

StormControlParameters

Name	Description	Schema
storm_control_actions optional	Default action (Discard) is implicit. In addition, other list of actions can be specified here	Any of [‘interface-shutdown’]
recovery_timeout optional	Timeout in seconds. This enables the affected interface to recover automatically from the error condition after the specified period of time	integer
no_unregistered_multicast optional	if set to true, disable unregistered multicast traffic storm control	boolean
no_registered_multicast optional	if set to true, disable registered multicast traffic storm control	boolean
no_unknown_unicast optional	if set to true, disable unknown unicast traffic storm control	boolean
no_multicast optional	if set to true, disable muticast traffic storm control	boolean
no_broadcast optional	if set to true, disable broadcast traffic storm control	boolean
bandwidth_percent required	Configure storm control bandwidth level as percentage	integer

SflowParameters

Name	Description	Schema
stats_collection_frequency optional	Represents polling interval and sample rate either at the global level or at per interface level. Polling interval is specified in seconds that the device waits between port statistics update messages. Sample rate is specified as a number (one packet out of number).	StatsCollectionFrequency
agent_id optional	IP address to be assigned as the agent ID for the sFlow agent.	string
adaptive_sample_rate optional	Represents maximum number of samples that should be generated per line card.	integer
enabled_interface_type optional	User can enable sflow either on all interfaces or all fabric ports or all access ports or custom list of interfaces.	Any of [‘all’, ‘fabric’, ‘service’, ‘access’, ‘custom’]
enabled_interface_params optional	If interface type is set to custom, this represents the list of physical interfaces to be enabled for sflow. User can specify polling interval and sample rate for each interface in this custom list.	EnabledInterfaceParams

GrpcParameters

Name	Description	Schema
allow_clients required	whitelist subnet of allowed clients on which various KPIs can be monitored.	SubnetListType
enabled_sensor_params optional	List of different top level sensor params that the user wishes to monitor using telemetry. The user can include one or all of these for telemetry monitoring by selecting specific options.	EnabledSensorParams
secure_mode optional	secure (SSL) or cleartext mode of gRPC configuration.	Any of [‘cleartext’, ‘ssl’]

SnmpParameters

Name	Description	Schema
enabled_sensor_params optional	List of different top level sensor params that the user wishes to monitor using telemetry. The user can include one or all of these for telemetry monitoring by selecting specific options.	EnabledSensorParams

NetconfParameters

Name	Description	Schema
enabled_sensor_params optional	List of different top level sensor params that the user wishes to monitor using telemetry. The user can include one or all of these for telemetry monitoring by selecting specific options.	EnabledSensorParams

PortParameters

Name	Description	Schema
port_disable optional		boolean
port_mtu optional		integer
port_description optional		string

PortProfileParameters

Name	Description	Schema
port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
flow_control optional	User can enable this option to configure flow control.	boolean
lacp_params optional	Represents LACP configuration parameters.	LacpParams
bpdu_loop_protection optional	User can enable this option to prevent loops on edge interfaces. This is applied on unit with family ethernet-switching.	boolean
port_cos_untrust optional	Enabling this option causes an interface to be not trusted. Untrusting an interface is achieved by applying 802.1 IP untrust classifier configuration.	boolean

FabricNetworkTag

Name	Description	Schema
network_type optional		Any of [‘management’, ‘loopback’, ‘ip-fabric’, ‘pnf-servicechain’, ‘overlay-loopback’]

SerialNumListType

Name	Description	Schema
serial_num optional		string

AsnRangeType

Name	Description	Schema
asn_min optional		integer
asn_max optional		integer

NamespaceValue

Name	Description	Schema
ipv4_cidr optional	Namespace as IPV4 CIDR addresses	SubnetListType
asn optional	Namespace as Autonomous System Numbers	AutonomousSystemsType
mac_addr optional	Namespace as MAC addresses	MacAddressesType
asn_ranges optional	Namespace as ASN ranges	AsnRangeType
serial_nums optional	Namespace as MAC addresses	string

DevicePlatformListType

Name	Description	Schema
platform_name optional		string

InterfaceMapType

Name	Description	Schema
port_info optional		PortInfoType

RoutingBridgingRolesType

Name	Description	Schema
rb_roles optional		string

NodeProfileRolesType

Name	Description	Schema
role_mappings optional		NodeProfileRoleType

UserCredentials

Name	Description	Schema
username optional		string
password optional		string

SNMPCredentials

Name	Description	Schema
version optional		integer
local_port optional		integer
retries optional		integer
timeout optional		integer
v2_community optional		string
v3_security_name optional		string
v3_security_level optional		string
v3_security_engine_id optional		string
v3_context optional		string
v3_context_engine_id optional		string
v3_authentication_protocol optional		string
v3_authentication_password optional		string
v3_privacy_protocol optional		string
v3_privacy_password optional		string
v3_engine_id optional		string
v3_engine_boots optional		integer
v3_engine_time optional		integer

DnsmasqLeaseParameters

Name	Description	Schema
lease_expiry_time optional		integer
client_id optional		string

LogicalRouterPRListType

Name	Description	Schema
logical_router_list optional	List of Destination LRs properties	LogicalRouterPRListParams

VMIVirtualPortGroupAttributes

Name	Description	Schema
vlan_tag optional	Tagged VLAN	integer
native_vlan_tag optional	Untagged VLAN	integer

ESXIProperties

Name	Description	Schema
dvs_name optional	Name of the Distributed Virtual Switch(DVS) assigned to Port.	string
dvs_id optional	MOid of the Distributed Virtual Switch(DVS) assigned to Port.	string

BaremetalPortInfo

Name	Description	Schema
pxe_enabled optional	Indicates whether PXE is enabled or disabled on the Port.	boolean
local_link_connection optional	The Port binding profile	LocalLinkConnection
node_uuid optional	UUID of the parent node where this port is connected	string
address optional	Mac Address of the NIC in Node	string

CloudInstanceInfo

Name	Description	Schema
os_version optional	specific version of operating system	string
operating_system optional	Name of operating system, ex - centos7 or ubuntu16	string
roles optional	Roles of the cloud instance	string
availability_zone optional	Availability zone to which the instance belongs to	string
instance_type optional	size of instance	string
machine_id optional	image (ami) id of instance	string
volume_size optional	Size of the volume for the cloud instance	integer

ESXIHostInfo

Name	Description	Schema
username optional	username	string
datacenter optional	datacenter in vCenter	string
esxi_name optional	ESXI host name(ip)	string
cluster optional	cluster in vCenter	string
mac optional	mac address for contrailvm	string
datastore optional	datastore in vCenter	string
password optional	ESXI host password	string
vcenter_server optional	vCenter server	string

BaremetalPortGroupInfo

Name	Description	Schema
standalone_ports_supported optional	Indicates whether ports that are members of this portgroup can be used as stand- alone ports.	boolean
node_uuid optional	UUID of the parent node where this port is connected	string
properties optional	Key/value properties related to the port group’s configuration.	PortGroupProperties
address optional	Mac Address of the NIC in Node	string
mode optional	Mode of the port group	string

BaremetalServerInfo

Name	Description	Schema
network_interface optional	Networking interface	string
driver optional	IPMI driver	string
properties optional	Details of baremetal hardware for scheduler	BaremetalProperties
driver_info optional	Details of the driver for power management	DriverInfo
name optional	Name of the Baremetal server	string

ServiceVirtualNetworkType

Name	Description	Schema
virtual_network_type optional		string

RouteListType

Name	Description	Schema
route optional		string

RoutingPolicyType

Name	Description	Schema
sequence optional		string

BgpRouterParams

Name	Description	Schema
admin_down optional	Administratively up or down.	boolean
vendor optional	Vendor name for this BGP router, contrail, juniper or cisco etc.	string
cluster_id optional	Cluster Id for this BGP router.	integer
autonomous_system required	Autonomous System number for this BGP router. Currently only 16 bit AS number is supported. For contrail control nodes this has to be equal to global AS number.	integer
identifier required	Router ID for this BGP router. Dotted ip notation. For contrail control-nodes System will automatically assign value of address field.	string
address required	Ip address used to reach this BGP router by the system.	string
port optional	TCP port number on which BGP protocol connections are accepted. default is based on standareds.	integer
source_port optional	For system internal use in BGPaaS service.	integer
hold_time optional	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds	integer
address_families optional	BGP address families supported by BGP router	AddressFamilies
auth_data optional	Authentication related configuration like type, keys etc.	AuthenticationData
local_autonomous_system optional	BgpRouter specific Autonomous System number if different from global AS number. Typically used when clusters of control nodes in same contrail system are in different locations. Currently only 16 bit AS number is supported.	integer
router_type optional	BGP router type.	Any of [‘control-node’, ‘external-control-node’, ‘router’, ‘bgpaas-server’, ‘bgpaas-client’]
gateway_address optional	gateway-address field is used only for router-type bgpaas-client. It holds the ipv4 gateway address for the ipv4 subnet from which the client has IP address. The value is used as nexthop when advertising routes to the client via bgp.	string
ipv6_gateway_address optional	The ipv6-gateway-address field is used only for router-type bgpaas-client. It holds ipv6 gateway address for ipv6 subnet from which the client has IP address. The value is used as nexthop when advertising routes to the client via bgp. Note that the ipv6-gateway-address can be a regular ipv6 address or a ipv4 -mapped-ipv6 adddress.	string

BgpPeeringAttributes

Name	Description	Schema
session required	List of BGP sessions parameters. There can be multiple BGP sessions between two BGP routers. Currently only 1 session is supported.	BgpSession

BgpSessionAttributes

Name	Description	Schema
bgp_router optional	When the parameters are uni-directional the bgp-router element specifies to which node the configuration applies. If missing the attributes apply to both ends of the session.	string
admin_down optional	Administratively mark this session down.	boolean
passive optional	This is passive session. It will not initiated connection. This is not relevant when session attributes represent common part. It is recommended that it should not be set to true in current release.	boolean
as_override optional	To Be Added	boolean
hold_time optional	A non-zero hold-time overrides the hold-time inherited from the bgp-router configuration. BGP hold time in seconds [0-65535], Max time to detect liveliness of peer.	integer
loop_count optional	For routing loop detection, loop-count is the number of times the local AS is allowed in the AS_PATH attribute.	integer
local_autonomous_system optional	Local autonomous system number used for this particular session. If configured, this overrides autonomous-system number and local-autonomous-system number configured under BgpRouterParams	integer
address_families optional	BGP address families supported on this session.	AddressFamilies
auth_data optional	Authentication related configuration for this session like type, keys etc.	AuthenticationData
family_attributes optional	Session attributes over ride per BGP address family. Attributes like address family, loop-count and prefix-limit.	BgpFamilyAttributes
private_as_action optional	Remove or replace private ASes from AS Path attributes advertised to this session.	Any of [‘remove’, ‘remove-all’, ‘replace-all’]
route_origin_override optional	User defined route origin value to override	RouteOriginOverride

AddressFamilies

Name	Description	Schema
family optional	BGP address families supported by contrail.	Any of [‘inet’, ‘inet-labeled’, ‘inet-vpn’, ‘e-vpn’, ‘erm-vpn’, ‘route-target’, ‘inet6’, ‘inet-mvpn’, ‘inet6-vpn’]

ServiceChainInfo

Name	Description	Schema
routing_instance optional		string
prefix optional		string
service_chain_address optional		string
service_instance optional		string
source_routing_instance optional		string
service_chain_id optional		string
sc_head optional		boolean
retain_as_path optional		boolean

StaticRouteEntriesType

Name	Description	Schema
route optional		StaticRouteType

ConnectionType

Name	Description	Schema
destination_instance optional		string

InstanceTargetType

Name	Description	Schema
import_export optional		Any of [‘import’, ‘export’]

DefaultProtocolType

Name	Description	Schema
bgp optional		ProtocolBgpType
ospf optional		ProtocolOspfType

PolicyStatementType

Name	Description	Schema
term optional		PolicyTermType

FieldNamesList

Name	Description	Schema
field_names optional		string

StructuredSyslogLinkmap

Name	Description	Schema
links optional		StructuredSyslogLinkType

StructuredSyslogLANSegmentList

Name	Description	Schema
LANSegmentList optional		StructuredSyslogLANSegmentType

StructuredSyslogDSCPMap

Name	Description	Schema
dscpListIPv4 optional		StructuredSyslogDSCPType
dscpListIPv6 optional		StructuredSyslogDSCPType

AccessControlListCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-network’, ‘security-group’]
access_control_list_entries optional	Automatically generated by system based on security groups or network policies.	AclEntriesType
access_control_list_hash optional	A hash value of all the access-control-list-entries in this ACL objects automatically generated by system.	unsignedLong
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AccessControlListReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
access_control_list_entries optional	Automatically generated by system based on security groups or network policies.	AclEntriesType
access_control_list_hash optional	A hash value of all the access-control-list-entries in this ACL objects automatically generated by system.	unsignedLong
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AccessControlListReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
access_control_list_entries optional	Automatically generated by system based on security groups or network policies.	AclEntriesType
access_control_list_hash optional	A hash value of all the access-control-list-entries in this ACL objects automatically generated by system.	unsignedLong
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AccessControlListUpdate

Name	Description	Schema
access_control_list_entries optional	Automatically generated by system based on security groups or network policies.	AclEntriesType
access_control_list_hash optional	A hash value of all the access-control-list-entries in this ACL objects automatically generated by system.	unsignedLong
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AddressGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘policy-management’, ‘project’]
address_group_prefix optional	List of IP prefix	SubnetListType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AddressGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
address_group_prefix optional	List of IP prefix	SubnetListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AddressGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
address_group_prefix optional	List of IP prefix	SubnetListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
firewall_rule_back_refs optional	List of firewall-rule references	ResourceReference array

AddressGroupUpdate

Name	Description	Schema
address_group_prefix optional	List of IP prefix	SubnetListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AlarmCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’, ‘project’]
uve_keys required	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.,	UveKeysType
alarm_severity required	Severity level for the alarm.	number
alarm_rules optional	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}, ...]}]}	AlarmOrList
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AlarmReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
uve_keys optional	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.,	UveKeysType
alarm_severity optional	Severity level for the alarm.	number
alarm_rules optional	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}, ...]}]}	AlarmOrList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AlarmReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
uve_keys optional	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.,	UveKeysType
alarm_severity optional	Severity level for the alarm.	number
alarm_rules optional	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}, ...]}]}	AlarmOrList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AlarmUpdate

Name	Description	Schema
uve_keys optional	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.,	UveKeysType
alarm_severity optional	Severity level for the alarm.	number
alarm_rules optional	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}, ...]}]}	AlarmOrList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AliasIpCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘alias-ip-pool’]
alias_ip_address required	Alias ip address.	string
alias_ip_address_family optional	Ip address family of the alias ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs required	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

AliasIpReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
alias_ip_address optional	Alias ip address.	string
alias_ip_address_family optional	Ip address family of the alias ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs optional	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

AliasIpReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
alias_ip_address optional	Alias ip address.	string
alias_ip_address_family optional	Ip address family of the alias ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs optional	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

AliasIpUpdate

Name	Description	Schema
alias_ip_address_family optional	Ip address family of the alias ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs optional	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

AliasIpPoolCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-network’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AliasIpPoolReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AliasIpPoolReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
project_back_refs optional	List of project references	ResourceReference array

AliasIpPoolUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsAlarmNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
analytics_alarm_node_ip_address optional	Ip address of the analytics alarm node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsAlarmNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
analytics_alarm_node_ip_address optional	Ip address of the analytics alarm node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsAlarmNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
analytics_alarm_node_ip_address optional	Ip address of the analytics alarm node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsAlarmNodeUpdate

Name	Description	Schema
analytics_alarm_node_ip_address optional	Ip address of the analytics alarm node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
analytics_node_ip_address optional	Ip address of the analytics node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
analytics_node_ip_address optional	Ip address of the analytics node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
analytics_node_ip_address optional	Ip address of the analytics node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsNodeUpdate

Name	Description	Schema
analytics_node_ip_address optional	Ip address of the analytics node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsSnmpNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
analytics_snmp_node_ip_address optional	Ip address of the analytics snmp node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsSnmpNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
analytics_snmp_node_ip_address optional	Ip address of the analytics snmp node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsSnmpNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
analytics_snmp_node_ip_address optional	Ip address of the analytics snmp node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AnalyticsSnmpNodeUpdate

Name	Description	Schema
analytics_snmp_node_ip_address optional	Ip address of the analytics snmp node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ApiAccessListCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘domain’, ‘project’, ‘global-system-config’]
api_access_list_entries required	List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).	RbacRuleEntriesType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ApiAccessListReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
api_access_list_entries optional	List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).	RbacRuleEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ApiAccessListReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
api_access_list_entries optional	List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).	RbacRuleEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ApiAccessListUpdate

Name	Description	Schema
api_access_list_entries optional	List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).	RbacRuleEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ApplicationPolicySetCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘policy-management’, ‘project’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_policy_refs required	List of firewall-policy references	ApplicationPolicySetFirewallPolicyRefs array
global_vrouter_config_refs optional	List of global-vrouter-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ApplicationPolicySetReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
all_applications optional	If set, indicates application policy set to be applied to all application tags	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_policy_refs optional	List of firewall-policy references	ApplicationPolicySetFirewallPolicyRefs array
global_vrouter_config_refs optional	List of global-vrouter-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ApplicationPolicySetReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
all_applications optional	If set, indicates application policy set to be applied to all application tags	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_policy_refs optional	List of firewall-policy references	ApplicationPolicySetFirewallPolicyRefs array
global_vrouter_config_refs optional	List of global-vrouter-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
project_back_refs optional	List of project references	ResourceReference array

ApplicationPolicySetUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_policy_refs optional	List of firewall-policy references	ApplicationPolicySetFirewallPolicyRefs array
global_vrouter_config_refs optional	List of global-vrouter-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

BgpAsAServiceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
autonomous_system required	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
bgpaas_shared optional	True if only one BGP router needs to be created. Otherwise, one BGP router is created for each VMI	boolean
bgpaas_ip_address required	Ip address of the BGP peer.	string
bgpaas_session_attributes required	BGP peering session attributes.	BgpSessionAttributes
bgpaas_ipv4_mapped_ipv6_nexthop optional	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.	boolean
bgpaas_suppress_route_advertisement optional	True when server should not advertise any routes to the client i.e. the client has static routes (typically a default) configured.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	BgpAsAServiceControlNodeZoneRefs array
virtual_machine_interface_refs required	List of virtual-machine-interface references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

BgpAsAServiceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
autonomous_system optional	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
bgpaas_shared optional	True if only one BGP router needs to be created. Otherwise, one BGP router is created for each VMI	boolean
bgpaas_ip_address optional	Ip address of the BGP peer.	string
bgpaas_session_attributes optional	BGP peering session attributes.	BgpSessionAttributes
bgpaas_ipv4_mapped_ipv6_nexthop optional	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.	boolean
bgpaas_suppress_route_advertisement optional	True when server should not advertise any routes to the client i.e. the client has static routes (typically a default) configured.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	BgpAsAServiceControlNodeZoneRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

BgpAsAServiceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
autonomous_system optional	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
bgpaas_shared optional	True if only one BGP router needs to be created. Otherwise, one BGP router is created for each VMI	boolean
bgpaas_ip_address optional	Ip address of the BGP peer.	string
bgpaas_session_attributes optional	BGP peering session attributes.	BgpSessionAttributes
bgpaas_ipv4_mapped_ipv6_nexthop optional	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.	boolean
bgpaas_suppress_route_advertisement optional	True when server should not advertise any routes to the client i.e. the client has static routes (typically a default) configured.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	BgpAsAServiceControlNodeZoneRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

BgpAsAServiceUpdate

Name	Description	Schema
autonomous_system optional	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
bgpaas_shared optional	True if only one BGP router needs to be created. Otherwise, one BGP router is created for each VMI	boolean
bgpaas_ip_address optional	Ip address of the BGP peer.	string
bgpaas_session_attributes optional	BGP peering session attributes.	BgpSessionAttributes
bgpaas_ipv4_mapped_ipv6_nexthop optional	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.	boolean
bgpaas_suppress_route_advertisement optional	True when server should not advertise any routes to the client i.e. the client has static routes (typically a default) configured.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	BgpAsAServiceControlNodeZoneRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

BgpRouterCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘routing-instance’]
bgp_router_parameters required	BGP router configuration parameters like ip address, AS number, hold time etc.	BgpRouterParams
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	ResourceReference array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	BgpRouterBgpRouterRefs array
tag_refs optional	List of tag references	ResourceReference array

BgpRouterReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
bgp_router_parameters optional	BGP router configuration parameters like ip address, AS number, hold time etc.	BgpRouterParams
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	ResourceReference array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	BgpRouterBgpRouterRefs array
tag_refs optional	List of tag references	ResourceReference array

BgpRouterReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
bgp_router_parameters optional	BGP router configuration parameters like ip address, AS number, hold time etc.	BgpRouterParams
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	ResourceReference array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	BgpRouterBgpRouterRefs array
tag_refs optional	List of tag references	ResourceReference array
global_system_config_back_refs optional	List of global-system-config references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
bgp_as_a_service_back_refs optional	List of bgp-as-a-service references	ResourceReference array
bgp_router_back_refs optional	List of bgp-router back references	BgpRouterBgpRouterRefs array

BgpRouterUpdate

Name	Description	Schema
bgp_router_parameters optional	BGP router configuration parameters like ip address, AS number, hold time etc.	BgpRouterParams
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
control_node_zone_refs optional	List of control-node-zone references	ResourceReference array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	BgpRouterBgpRouterRefs array
tag_refs optional	List of tag references	ResourceReference array

BgpvpnCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
bgpvpn_type required	BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3).	Any of [‘l2’, ‘l3’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

BgpvpnReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
bgpvpn_type optional	BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3).	Any of [‘l2’, ‘l3’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

BgpvpnReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
bgpvpn_type optional	BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3).	Any of [‘l2’, ‘l3’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array

BgpvpnUpdate

Name	Description	Schema
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

BridgeDomainCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-network’]
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
isid required	i-sid value	number
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

BridgeDomainReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
isid optional	i-sid value	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

BridgeDomainReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
isid optional	i-sid value	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface back references	VirtualMachineInterfaceBridgeDomainRefs array

BridgeDomainUpdate

Name	Description	Schema
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
isid optional	i-sid value	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CardCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
interface_map required	Interface map of all the physical ports on a physical interface card.	InterfaceMapType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CardReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
interface_map optional	Interface map of all the physical ports on a physical interface card.	InterfaceMapType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CardReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
interface_map optional	Interface map of all the physical ports on a physical interface card.	InterfaceMapType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
hardware_back_refs optional	List of hardware references	ResourceReference array

CardUpdate

Name	Description	Schema
interface_map optional	Interface map of all the physical ports on a physical interface card.	InterfaceMapType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CliConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘physical-router’]
accepted_cli_config optional	Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with Contrail configuration	string
commit_diff_list optional	CLI diff object containing details about the commit such as username, time and the configuration diff	CliDiffListType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CliConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
accepted_cli_config optional	Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with Contrail configuration	string
commit_diff_list optional	CLI diff object containing details about the commit such as username, time and the configuration diff	CliDiffListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CliConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
accepted_cli_config optional	Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with Contrail configuration	string
commit_diff_list optional	CLI diff object containing details about the commit such as username, time and the configuration diff	CliDiffListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CliConfigUpdate

Name	Description	Schema
accepted_cli_config optional	Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with Contrail configuration	string
commit_diff_list optional	CLI diff object containing details about the commit such as username, time and the configuration diff	CliDiffListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigDatabaseNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
config_database_node_ip_address required	Ip address of the Config DB node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigDatabaseNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
config_database_node_ip_address optional	Ip address of the Config DB node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigDatabaseNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
config_database_node_ip_address optional	Ip address of the Config DB node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigDatabaseNodeUpdate

Name	Description	Schema
config_database_node_ip_address optional	Ip address of the Config DB node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
config_node_ip_address optional	Ip address of the config node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
config_node_ip_address optional	Ip address of the config node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
config_node_ip_address optional	Ip address of the config node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigNodeUpdate

Name	Description	Schema
config_node_ip_address optional	Ip address of the config node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigPropertiesCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
properties optional	List of Config properties	KeyValuePairs
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigPropertiesReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
properties optional	List of Config properties	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigPropertiesReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
properties optional	List of Config properties	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigPropertiesUpdate

Name	Description	Schema
properties optional	List of Config properties	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigRootCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigRootReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigRootReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ConfigRootUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ControlNodeZoneCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ControlNodeZoneReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ControlNodeZoneReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
bgp_as_a_service_back_refs optional	List of bgp-as-a-service back references	BgpAsAServiceControlNodeZoneRefs array
bgp_router_back_refs optional	List of bgp-router references	ResourceReference array

ControlNodeZoneUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

CustomerAttachmentCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
attachment_address optional		`AttachmentAddressType`_
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
floating_ip_refs optional	List of floating-ip references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

CustomerAttachmentReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
attachment_address optional		`AttachmentAddressType`_
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
floating_ip_refs optional	List of floating-ip references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

CustomerAttachmentReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
attachment_address optional		`AttachmentAddressType`_
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
floating_ip_refs optional	List of floating-ip references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

CustomerAttachmentUpdate

Name	Description	Schema
attachment_address optional		`AttachmentAddressType`_
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
floating_ip_refs optional	List of floating-ip references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DataCenterInterconnectCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
data_center_interconnect_bgp_hold_time optional	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds.	number
data_center_interconnect_mode optional	Data Center InterConnect modes can be l2 or l3. l2 - DCI mode l2 stretch. l3 - DCI mode l3 stretch.	Any of [‘l3’, ‘l2’]
data_center_interconnect_bgp_address_families optional	BGP address families supported by BGP router.	AddressFamilies
data_center_interconnect_configured_route_target_list optional	List of route targets that represent this logical router, all virtual networks connected to this DCI will have this as their route target list.	RouteTargetList
data_center_interconnect_type optional	Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.	Any of [‘inter_fabric’, ‘intra_fabric’]
destination_physical_router_list optional	holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object	LogicalRouterPRListType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DataCenterInterconnectReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
data_center_interconnect_bgp_hold_time optional	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds.	number
data_center_interconnect_mode optional	Data Center InterConnect modes can be l2 or l3. l2 - DCI mode l2 stretch. l3 - DCI mode l3 stretch.	Any of [‘l3’, ‘l2’]
data_center_interconnect_bgp_address_families optional	BGP address families supported by BGP router.	AddressFamilies
data_center_interconnect_configured_route_target_list optional	List of route targets that represent this logical router, all virtual networks connected to this DCI will have this as their route target list.	RouteTargetList
data_center_interconnect_type optional	Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.	Any of [‘inter_fabric’, ‘intra_fabric’]
destination_physical_router_list optional	holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object	LogicalRouterPRListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DataCenterInterconnectReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
data_center_interconnect_bgp_hold_time optional	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds.	number
data_center_interconnect_mode optional	Data Center InterConnect modes can be l2 or l3. l2 - DCI mode l2 stretch. l3 - DCI mode l3 stretch.	Any of [‘l3’, ‘l2’]
data_center_interconnect_bgp_address_families optional	BGP address families supported by BGP router.	AddressFamilies
data_center_interconnect_configured_route_target_list optional	List of route targets that represent this logical router, all virtual networks connected to this DCI will have this as their route target list.	RouteTargetList
data_center_interconnect_type optional	Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.	Any of [‘inter_fabric’, ‘intra_fabric’]
destination_physical_router_list optional	holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object	LogicalRouterPRListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DataCenterInterconnectUpdate

Name	Description	Schema
data_center_interconnect_bgp_hold_time optional	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds.	number
data_center_interconnect_mode optional	Data Center InterConnect modes can be l2 or l3. l2 - DCI mode l2 stretch. l3 - DCI mode l3 stretch.	Any of [‘l3’, ‘l2’]
data_center_interconnect_bgp_address_families optional	BGP address families supported by BGP router.	AddressFamilies
data_center_interconnect_configured_route_target_list optional	List of route targets that represent this logical router, all virtual networks connected to this DCI will have this as their route target list.	RouteTargetList
data_center_interconnect_type optional	Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.	Any of [‘inter_fabric’, ‘intra_fabric’]
destination_physical_router_list optional	holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object	LogicalRouterPRListType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DatabaseNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
database_node_ip_address required	Ip address of the database node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DatabaseNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
database_node_ip_address optional	Ip address of the database node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DatabaseNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
database_node_ip_address optional	Ip address of the database node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DatabaseNodeUpdate

Name	Description	Schema
database_node_ip_address optional	Ip address of the database node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DeviceChassisCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_chassis_type optional	type of the chassis address if known.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DeviceChassisReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_chassis_type optional	type of the chassis address if known.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DeviceChassisReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_chassis_type optional	type of the chassis address if known.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array

DeviceChassisUpdate

Name	Description	Schema
device_chassis_type optional	type of the chassis address if known.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DeviceFunctionalGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
device_functional_group_description optional	Description of the functional group stating the functionality the devices would get if assigned to this group	string
device_functional_group_os_version optional	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	string
device_functional_group_routing_bridging_roles optional	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.	RoutingBridgingRolesType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_role_refs optional	List of physical-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DeviceFunctionalGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_functional_group_description optional	Description of the functional group stating the functionality the devices would get if assigned to this group	string
device_functional_group_os_version optional	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	string
device_functional_group_routing_bridging_roles optional	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.	RoutingBridgingRolesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_role_refs optional	List of physical-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DeviceFunctionalGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_functional_group_description optional	Description of the functional group stating the functionality the devices would get if assigned to this group	string
device_functional_group_os_version optional	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	string
device_functional_group_routing_bridging_roles optional	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.	RoutingBridgingRolesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_role_refs optional	List of physical-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array

DeviceFunctionalGroupUpdate

Name	Description	Schema
device_functional_group_description optional	Description of the functional group stating the functionality the devices would get if assigned to this group	string
device_functional_group_os_version optional	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	string
device_functional_group_routing_bridging_roles optional	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.	RoutingBridgingRolesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_role_refs optional	List of physical-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DeviceImageCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
device_image_file_name optional	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.	string
device_image_vendor_name required	Vendor name for device image. It is used by device manager during device image upgrade to match the PRouters vendor name	string
device_image_device_family required	Device family name for device image. It is used by device manager during device image upgrade to match the family name of the PRouter	string
device_image_supported_platforms optional	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	DevicePlatformListType
device_image_os_version required	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	string
device_image_file_uri optional	file uri for the device image uploaded to the image server.	string
device_image_size optional	file size of the device image that was uploaded to the image server.	number
device_image_md5 optional	md5 checksum of the image file that was uploaded to the image server.	string
device_image_sha1 optional	sha1 checksum of the image file that was uploaded to the image server.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
hardware_refs optional	List of hardware references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DeviceImageReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_image_file_name optional	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.	string
device_image_vendor_name optional	Vendor name for device image. It is used by device manager during device image upgrade to match the PRouters vendor name	string
device_image_device_family optional	Device family name for device image. It is used by device manager during device image upgrade to match the family name of the PRouter	string
device_image_supported_platforms optional	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	DevicePlatformListType
device_image_os_version optional	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	string
device_image_file_uri optional	file uri for the device image uploaded to the image server.	string
device_image_size optional	file size of the device image that was uploaded to the image server.	number
device_image_md5 optional	md5 checksum of the image file that was uploaded to the image server.	string
device_image_sha1 optional	sha1 checksum of the image file that was uploaded to the image server.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
hardware_refs optional	List of hardware references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DeviceImageReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
device_image_file_name optional	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.	string
device_image_vendor_name optional	Vendor name for device image. It is used by device manager during device image upgrade to match the PRouters vendor name	string
device_image_device_family optional	Device family name for device image. It is used by device manager during device image upgrade to match the family name of the PRouter	string
device_image_supported_platforms optional	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	DevicePlatformListType
device_image_os_version optional	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	string
device_image_file_uri optional	file uri for the device image uploaded to the image server.	string
device_image_size optional	file size of the device image that was uploaded to the image server.	number
device_image_md5 optional	md5 checksum of the image file that was uploaded to the image server.	string
device_image_sha1 optional	sha1 checksum of the image file that was uploaded to the image server.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
hardware_refs optional	List of hardware references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array

DeviceImageUpdate

Name	Description	Schema
device_image_file_name optional	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.	string
device_image_vendor_name optional	Vendor name for device image. It is used by device manager during device image upgrade to match the PRouters vendor name	string
device_image_device_family optional	Device family name for device image. It is used by device manager during device image upgrade to match the family name of the PRouter	string
device_image_supported_platforms optional	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	DevicePlatformListType
device_image_os_version optional	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	string
device_image_file_uri optional	file uri for the device image uploaded to the image server.	string
device_image_size optional	file size of the device image that was uploaded to the image server.	number
device_image_md5 optional	md5 checksum of the image file that was uploaded to the image server.	string
device_image_sha1 optional	sha1 checksum of the image file that was uploaded to the image server.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
hardware_refs optional	List of hardware references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

DevicemgrNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
devicemgr_node_ip_address optional	Ip address of the devicemgr node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DevicemgrNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
devicemgr_node_ip_address optional	Ip address of the devicemgr node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DevicemgrNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
devicemgr_node_ip_address optional	Ip address of the devicemgr node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DevicemgrNodeUpdate

Name	Description	Schema
devicemgr_node_ip_address optional	Ip address of the devicemgr node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DiscoveryServiceAssignmentCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DiscoveryServiceAssignmentReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DiscoveryServiceAssignmentReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DiscoveryServiceAssignmentUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DomainCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
domain_limits optional	Domain level quota, not currently implemented	DomainLimitsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DomainReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
domain_limits optional	Domain level quota, not currently implemented	DomainLimitsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DomainReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
domain_limits optional	Domain level quota, not currently implemented	DomainLimitsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DomainUpdate

Name	Description	Schema
domain_limits optional	Domain level quota, not currently implemented	DomainLimitsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DsaRuleCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘discovery-service-assignment’]
dsa_rule_entry required	rule entry defining publisher set and subscriber set.	DiscoveryServiceAssignmentType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DsaRuleReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
dsa_rule_entry optional	rule entry defining publisher set and subscriber set.	DiscoveryServiceAssignmentType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DsaRuleReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
dsa_rule_entry optional	rule entry defining publisher set and subscriber set.	DiscoveryServiceAssignmentType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

DsaRuleUpdate

Name	Description	Schema
dsa_rule_entry optional	rule entry defining publisher set and subscriber set.	DiscoveryServiceAssignmentType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

E2ServiceProviderCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
e2_service_provider_promiscuous optional	This service provider is connected to all other service providers.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
peering_policy_refs optional	List of peering-policy references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

E2ServiceProviderReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
e2_service_provider_promiscuous optional	This service provider is connected to all other service providers.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
peering_policy_refs optional	List of peering-policy references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

E2ServiceProviderReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
e2_service_provider_promiscuous optional	This service provider is connected to all other service providers.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
peering_policy_refs optional	List of peering-policy references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

E2ServiceProviderUpdate

Name	Description	Schema
e2_service_provider_promiscuous optional	This service provider is connected to all other service providers.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
peering_policy_refs optional	List of peering-policy references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FabricCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
fabric_ztp optional	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.	boolean
fabric_os_version optional	OS version of the entire fabric. It is updated when image upgrade is chosen during ztp.	string
fabric_credentials optional	List of device credentials to manage the network devices in the fabric.	DeviceCredentialList
fabric_enterprise_style optional	This attribute indicates whether to use enterprise-style or sp-style configuration in the fabric. True indicated enterprise-style.	boolean
disable_vlan_vn_uniqueness_check optional	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.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
intent_map_refs optional	List of intent-map references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	FabricVirtualNetworkRefs array
node_profile_refs optional	List of node-profile references	FabricNodeProfileRefs array
tag_refs optional	List of tag references	ResourceReference array

FabricReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
fabric_ztp optional	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.	boolean
fabric_os_version optional	OS version of the entire fabric. It is updated when image upgrade is chosen during ztp.	string
fabric_credentials optional	List of device credentials to manage the network devices in the fabric.	DeviceCredentialList
fabric_enterprise_style optional	This attribute indicates whether to use enterprise-style or sp-style configuration in the fabric. True indicated enterprise-style.	boolean
disable_vlan_vn_uniqueness_check optional	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.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
intent_map_refs optional	List of intent-map references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	FabricVirtualNetworkRefs array
node_profile_refs optional	List of node-profile references	FabricNodeProfileRefs array
tag_refs optional	List of tag references	ResourceReference array

FabricReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
fabric_ztp optional	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.	boolean
fabric_os_version optional	OS version of the entire fabric. It is updated when image upgrade is chosen during ztp.	string
fabric_credentials optional	List of device credentials to manage the network devices in the fabric.	DeviceCredentialList
fabric_enterprise_style optional	This attribute indicates whether to use enterprise-style or sp-style configuration in the fabric. True indicated enterprise-style.	boolean
disable_vlan_vn_uniqueness_check optional	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.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
intent_map_refs optional	List of intent-map references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	FabricVirtualNetworkRefs array
node_profile_refs optional	List of node-profile references	FabricNodeProfileRefs array
tag_refs optional	List of tag references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array
data_center_interconnect_back_refs optional	List of data-center-interconnect references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array

FabricUpdate

Name	Description	Schema
fabric_ztp optional	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.	boolean
fabric_os_version optional	OS version of the entire fabric. It is updated when image upgrade is chosen during ztp.	string
fabric_credentials optional	List of device credentials to manage the network devices in the fabric.	DeviceCredentialList
fabric_enterprise_style optional	This attribute indicates whether to use enterprise-style or sp-style configuration in the fabric. True indicated enterprise-style.	boolean
disable_vlan_vn_uniqueness_check optional	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.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
intent_map_refs optional	List of intent-map references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	FabricVirtualNetworkRefs array
node_profile_refs optional	List of node-profile references	FabricNodeProfileRefs array
tag_refs optional	List of tag references	ResourceReference array

FabricNamespaceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘fabric’]
fabric_namespace_type optional	Supported namespace types	Any of [‘IPV4-CIDR’, ‘ASN’, ‘ASN_RANGE’, ‘MAC_ADDR’, ‘SERIAL_NUM’]
fabric_namespace_value optional	namespace value of type defined by the namespace-type.	NamespaceValue
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FabricNamespaceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
fabric_namespace_type optional	Supported namespace types	Any of [‘IPV4-CIDR’, ‘ASN’, ‘ASN_RANGE’, ‘MAC_ADDR’, ‘SERIAL_NUM’]
fabric_namespace_value optional	namespace value of type defined by the namespace-type.	NamespaceValue
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FabricNamespaceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
fabric_namespace_type optional	Supported namespace types	Any of [‘IPV4-CIDR’, ‘ASN’, ‘ASN_RANGE’, ‘MAC_ADDR’, ‘SERIAL_NUM’]
fabric_namespace_value optional	namespace value of type defined by the namespace-type.	NamespaceValue
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FabricNamespaceUpdate

Name	Description	Schema
fabric_namespace_type optional	Supported namespace types	Any of [‘IPV4-CIDR’, ‘ASN’, ‘ASN_RANGE’, ‘MAC_ADDR’, ‘SERIAL_NUM’]
fabric_namespace_value optional	namespace value of type defined by the namespace-type.	NamespaceValue
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FeatureReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FeatureReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
feature_back_refs optional	List of feature references	ResourceReference array
role_definition_back_refs optional	List of role-definition references	ResourceReference array

FeatureUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FeatureConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘role-definition’]
feature_config_additional_params optional	Additional configuration parameters for the feature.	KeyValuePairs
feature_config_vendor_config optional	Vendor specific configuration/parameters for the feature.	KeyValuePairs
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
feature_config_additional_params optional	Additional configuration parameters for the feature.	KeyValuePairs
feature_config_vendor_config optional	Vendor specific configuration/parameters for the feature.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
feature_config_additional_params optional	Additional configuration parameters for the feature.	KeyValuePairs
feature_config_vendor_config optional	Vendor specific configuration/parameters for the feature.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureConfigUpdate

Name	Description	Schema
feature_config_additional_params optional	Additional configuration parameters for the feature.	KeyValuePairs
feature_config_vendor_config optional	Vendor specific configuration/parameters for the feature.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureFlagCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
feature_id required	identifier for this feature	Any of [‘default’, ‘__test_feature_1__’, ‘__test_feature_2__’]
feature_flag_version required	contrail release in which this feature flag is created.	string
enable_feature optional	knob to enable or disable an allowed feature.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureFlagReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
feature_description optional	short explanation about the feature.	string
feature_id optional	identifier for this feature	Any of [‘default’, ‘__test_feature_1__’, ‘__test_feature_2__’]
feature_flag_version optional	contrail release in which this feature flag is created.	string
feature_release optional	version of release in which the feature is introduced.	string
enable_feature optional	knob to enable or disable an allowed feature.	boolean
feature_state optional	state of the feature	Any of [‘experimental’, ‘alpha’, ‘beta’, ‘in-progress’, ‘pre-retired’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureFlagReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
feature_description optional	short explanation about the feature.	string
feature_id optional	identifier for this feature	Any of [‘default’, ‘__test_feature_1__’, ‘__test_feature_2__’]
feature_flag_version optional	contrail release in which this feature flag is created.	string
feature_release optional	version of release in which the feature is introduced.	string
enable_feature optional	knob to enable or disable an allowed feature.	boolean
feature_state optional	state of the feature	Any of [‘experimental’, ‘alpha’, ‘beta’, ‘in-progress’, ‘pre-retired’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FeatureFlagUpdate

Name	Description	Schema
feature_id optional	identifier for this feature	Any of [‘default’, ‘__test_feature_1__’, ‘__test_feature_2__’]
feature_flag_version optional	contrail release in which this feature flag is created.	string
enable_feature optional	knob to enable or disable an allowed feature.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FirewallPolicyCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘policy-management’, ‘project’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_rule_refs optional	List of firewall-rule references	FirewallPolicyFirewallRuleRefs array
security_logging_object_refs optional	List of security-logging-object references	FirewallPolicySecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array

FirewallPolicyReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_rule_refs optional	List of firewall-rule references	FirewallPolicyFirewallRuleRefs array
security_logging_object_refs optional	List of security-logging-object references	FirewallPolicySecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array

FirewallPolicyReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_rule_refs optional	List of firewall-rule references	FirewallPolicyFirewallRuleRefs array
security_logging_object_refs optional	List of security-logging-object references	FirewallPolicySecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array
application_policy_set_back_refs optional	List of application-policy-set back references	ApplicationPolicySetFirewallPolicyRefs array

FirewallPolicyUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
firewall_rule_refs optional	List of firewall-rule references	FirewallPolicyFirewallRuleRefs array
security_logging_object_refs optional	List of security-logging-object references	FirewallPolicySecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array

FirewallRuleCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘policy-management’, ‘project’]
action_list required	Actions to be performed if packets match condition	ActionListType
service optional	Service (port, protocol) for packets match condition	FirewallServiceType
endpoint_1 required	match condition for traffic source	FirewallRuleEndpointType
endpoint_2 required	match condition for traffic destination	FirewallRuleEndpointType
match_tags required	matching tags for source and destination endpoints	FirewallRuleMatchTagsType
direction required	Direction in the rule	Any of [‘<’, ‘>’, ‘<>’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_group_refs optional	List of service-group references	ResourceReference array
security_logging_object_refs optional	List of security-logging-object references	FirewallRuleSecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array

FirewallRuleReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
action_list optional	Actions to be performed if packets match condition	ActionListType
service optional	Service (port, protocol) for packets match condition	FirewallServiceType
endpoint_1 optional	match condition for traffic source	FirewallRuleEndpointType
endpoint_2 optional	match condition for traffic destination	FirewallRuleEndpointType
match_tags optional	matching tags for source and destination endpoints	FirewallRuleMatchTagsType
match_tag_types optional	matching tags ids for source and destination endpoints	FirewallRuleMatchTagsTypeIdList
direction optional	Direction in the rule	Any of [‘<’, ‘>’, ‘<>’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_group_refs optional	List of service-group references	ResourceReference array
address_group_refs optional	List of address-group references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
security_logging_object_refs optional	List of security-logging-object references	FirewallRuleSecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array

FirewallRuleReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
action_list optional	Actions to be performed if packets match condition	ActionListType
service optional	Service (port, protocol) for packets match condition	FirewallServiceType
endpoint_1 optional	match condition for traffic source	FirewallRuleEndpointType
endpoint_2 optional	match condition for traffic destination	FirewallRuleEndpointType
match_tags optional	matching tags for source and destination endpoints	FirewallRuleMatchTagsType
match_tag_types optional	matching tags ids for source and destination endpoints	FirewallRuleMatchTagsTypeIdList
direction optional	Direction in the rule	Any of [‘<’, ‘>’, ‘<>’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_group_refs optional	List of service-group references	ResourceReference array
address_group_refs optional	List of address-group references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
security_logging_object_refs optional	List of security-logging-object references	FirewallRuleSecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array
firewall_policy_back_refs optional	List of firewall-policy back references	FirewallPolicyFirewallRuleRefs array

FirewallRuleUpdate

Name	Description	Schema
action_list optional	Actions to be performed if packets match condition	ActionListType
service optional	Service (port, protocol) for packets match condition	FirewallServiceType
endpoint_1 optional	match condition for traffic source	FirewallRuleEndpointType
endpoint_2 optional	match condition for traffic destination	FirewallRuleEndpointType
match_tags optional	matching tags for source and destination endpoints	FirewallRuleMatchTagsType
direction optional	Direction in the rule	Any of [‘<’, ‘>’, ‘<>’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_group_refs optional	List of service-group references	ResourceReference array
security_logging_object_refs optional	List of security-logging-object references	FirewallRuleSecurityLoggingObjectRefs array
tag_refs optional	List of tag references	ResourceReference array

FloatingIpCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘floating-ip-pool’, ‘instance-ip’]
floating_ip_address required	Floating ip address.	string
floating_ip_is_virtual_ip optional	This floating ip is used as virtual ip (VIP) in case of LBaaS.	boolean
floating_ip_fixed_ip_address optional	This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.	string
floating_ip_address_family optional	Ip address family of the floating ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
floating_ip_port_mappings_enable optional	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.	boolean
floating_ip_port_mappings optional	List of PortMaps for this floating-ip.	PortMappings
floating_ip_traffic_direction optional	Specifies direction of traffic for the floating-ip	Any of [‘ingress’, ‘egress’, ‘both’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs required	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FloatingIpReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
floating_ip_address optional	Floating ip address.	string
floating_ip_is_virtual_ip optional	This floating ip is used as virtual ip (VIP) in case of LBaaS.	boolean
floating_ip_fixed_ip_address optional	This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.	string
floating_ip_address_family optional	Ip address family of the floating ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
floating_ip_port_mappings_enable optional	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.	boolean
floating_ip_port_mappings optional	List of PortMaps for this floating-ip.	PortMappings
floating_ip_traffic_direction optional	Specifies direction of traffic for the floating-ip	Any of [‘ingress’, ‘egress’, ‘both’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs optional	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FloatingIpReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
floating_ip_address optional	Floating ip address.	string
floating_ip_is_virtual_ip optional	This floating ip is used as virtual ip (VIP) in case of LBaaS.	boolean
floating_ip_fixed_ip_address optional	This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.	string
floating_ip_address_family optional	Ip address family of the floating ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
floating_ip_port_mappings_enable optional	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.	boolean
floating_ip_port_mappings optional	List of PortMaps for this floating-ip.	PortMappings
floating_ip_traffic_direction optional	Specifies direction of traffic for the floating-ip	Any of [‘ingress’, ‘egress’, ‘both’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs optional	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
customer_attachment_back_refs optional	List of customer-attachment references	ResourceReference array

FloatingIpUpdate

Name	Description	Schema
floating_ip_is_virtual_ip optional	This floating ip is used as virtual ip (VIP) in case of LBaaS.	boolean
floating_ip_fixed_ip_address optional	This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.	string
floating_ip_address_family optional	Ip address family of the floating ip, IpV4 or IpV6	Any of [‘v4’, ‘v6’]
floating_ip_port_mappings_enable optional	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.	boolean
floating_ip_port_mappings optional	List of PortMaps for this floating-ip.	PortMappings
floating_ip_traffic_direction optional	Specifies direction of traffic for the floating-ip	Any of [‘ingress’, ‘egress’, ‘both’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
project_refs optional	List of project references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FloatingIpPoolCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-network’]
floating_ip_pool_subnets optional	Subnets that restrict floating ip allocation from the corresponding virtual network.	FloatingIpPoolSubnetType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FloatingIpPoolReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
floating_ip_pool_subnets optional	Subnets that restrict floating ip allocation from the corresponding virtual network.	FloatingIpPoolSubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FloatingIpPoolReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
floating_ip_pool_subnets optional	Subnets that restrict floating ip allocation from the corresponding virtual network.	FloatingIpPoolSubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
project_back_refs optional	List of project references	ResourceReference array

FloatingIpPoolUpdate

Name	Description	Schema
floating_ip_pool_subnets optional	Subnets that restrict floating ip allocation from the corresponding virtual network.	FloatingIpPoolSubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

FlowNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
flow_node_ip_address optional	Ip address of the appformix flow node, set while provisioning.	string
flow_node_load_balancer_ip required	IP address of the load balancer node for xflow collectors, set while provisioning.	string
flow_node_inband_interface optional	In-Band interface name used for this flow node.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FlowNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
flow_node_ip_address optional	Ip address of the appformix flow node, set while provisioning.	string
flow_node_load_balancer_ip optional	IP address of the load balancer node for xflow collectors, set while provisioning.	string
flow_node_inband_interface optional	In-Band interface name used for this flow node.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

FlowNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
flow_node_ip_address optional	Ip address of the appformix flow node, set while provisioning.	string
flow_node_load_balancer_ip optional	IP address of the load balancer node for xflow collectors, set while provisioning.	string
flow_node_inband_interface optional	In-Band interface name used for this flow node.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array

FlowNodeUpdate

Name	Description	Schema
flow_node_ip_address optional	Ip address of the appformix flow node, set while provisioning.	string
flow_node_load_balancer_ip optional	IP address of the load balancer node for xflow collectors, set while provisioning.	string
flow_node_inband_interface optional	In-Band interface name used for this flow node.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ForwardingClassCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-qos-config’]
forwarding_class_id required	Unique ID for this forwarding class.	number
forwarding_class_dscp required	DSCP value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_vlan_priority required	802.1p value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_mpls_exp required	MPLS exp value to be written on outgoing packet for this forwarding-class.	number
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
qos_queue_refs required	List of qos-queue references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ForwardingClassReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
forwarding_class_id optional	Unique ID for this forwarding class.	number
forwarding_class_dscp optional	DSCP value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_vlan_priority optional	802.1p value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_mpls_exp optional	MPLS exp value to be written on outgoing packet for this forwarding-class.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
qos_queue_refs optional	List of qos-queue references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ForwardingClassReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
forwarding_class_id optional	Unique ID for this forwarding class.	number
forwarding_class_dscp optional	DSCP value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_vlan_priority optional	802.1p value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_mpls_exp optional	MPLS exp value to be written on outgoing packet for this forwarding-class.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
qos_queue_refs optional	List of qos-queue references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ForwardingClassUpdate

Name	Description	Schema
forwarding_class_id optional	Unique ID for this forwarding class.	number
forwarding_class_dscp optional	DSCP value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_vlan_priority optional	802.1p value to be written on outgoing packet for this forwarding-class.	number
forwarding_class_mpls_exp optional	MPLS exp value to be written on outgoing packet for this forwarding-class.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
qos_queue_refs optional	List of qos-queue references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

GlobalAnalyticsConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalAnalyticsConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalAnalyticsConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalAnalyticsConfigUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalQosConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
control_traffic_dscp required	DSCP value of IP header for control traffic	ControlTrafficDscpType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalQosConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
control_traffic_dscp optional	DSCP value of IP header for control traffic	ControlTrafficDscpType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalQosConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
control_traffic_dscp optional	DSCP value of IP header for control traffic	ControlTrafficDscpType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalQosConfigUpdate

Name	Description	Schema
control_traffic_dscp optional	DSCP value of IP header for control traffic	ControlTrafficDscpType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalSystemConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
autonomous_system required	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
enable_4byte_as optional	Knob to enable 4 byte Autonomous System number support.	boolean
graceful_restart_parameters optional	Graceful Restart parameters	GracefulRestartParametersType
fast_convergence_parameters optional	Fast Convergence parameters.	FastConvergenceParametersType
plugin_tuning optional	Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.	PluginProperties
data_center_interconnect_loopback_namespace optional	Used for assigning loopback addresses on interconnect physical devices.	SubnetListType
data_center_interconnect_asn_namespace optional	Used for assigning asn values on interconnect physical devices.	AsnRangeType
ibgp_auto_mesh optional	When true, system will automatically create BGP peering mesh with all control-nodes that have same BGP AS number as global AS number.	boolean
bgp_always_compare_med optional	Always compare MED even if paths are received from different ASes.	boolean
rd_cluster_seed optional	Used to create collision-free route distinguishers.	number
route_replication_threshold optional	Time to wait (in minutes) before enabling optimisation in route replication.	number
ip_fabric_subnets optional	List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic GRE tunnels on the SDN gateway.	SubnetListType
supported_device_families optional	List of all supported physical router device family names. Used by UI to show pick list.	DeviceFamilyListType
supported_vendor_hardwares optional	List of all supported vendor hardware platforms by the system. Used by UI to show pick list.	VendorHardwaresType
bgpaas_parameters optional	BGP As A Service Parameters configuration	BGPaaServiceParametersType
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
igmp_enable optional	IGMP mode at Global level.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
user_defined_log_statistics optional	stats name and patterns	UserDefinedLogStatList
enable_security_policy_draft optional		boolean
supported_fabric_annotations optional	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.	KeyValuePairs
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalSystemConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
autonomous_system optional	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
enable_4byte_as optional	Knob to enable 4 byte Autonomous System number support.	boolean
config_version optional	Version of OpenContrail software that generated this config.	string
graceful_restart_parameters optional	Graceful Restart parameters	GracefulRestartParametersType
fast_convergence_parameters optional	Fast Convergence parameters.	FastConvergenceParametersType
plugin_tuning optional	Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.	PluginProperties
data_center_interconnect_loopback_namespace optional	Used for assigning loopback addresses on interconnect physical devices.	SubnetListType
data_center_interconnect_asn_namespace optional	Used for assigning asn values on interconnect physical devices.	AsnRangeType
ibgp_auto_mesh optional	When true, system will automatically create BGP peering mesh with all control-nodes that have same BGP AS number as global AS number.	boolean
bgp_always_compare_med optional	Always compare MED even if paths are received from different ASes.	boolean
rd_cluster_seed optional	Used to create collision-free route distinguishers.	number
route_replication_threshold optional	Time to wait (in minutes) before enabling optimisation in route replication.	number
ip_fabric_subnets optional	List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic GRE tunnels on the SDN gateway.	SubnetListType
supported_device_families optional	List of all supported physical router device family names. Used by UI to show pick list.	DeviceFamilyListType
supported_vendor_hardwares optional	List of all supported vendor hardware platforms by the system. Used by UI to show pick list.	VendorHardwaresType
bgpaas_parameters optional	BGP As A Service Parameters configuration	BGPaaServiceParametersType
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
igmp_enable optional	IGMP mode at Global level.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
user_defined_log_statistics optional	stats name and patterns	UserDefinedLogStatList
enable_security_policy_draft optional		boolean
supported_fabric_annotations optional	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.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
bgp_router_refs optional	List of bgp-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

GlobalSystemConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
autonomous_system optional	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
enable_4byte_as optional	Knob to enable 4 byte Autonomous System number support.	boolean
config_version optional	Version of OpenContrail software that generated this config.	string
graceful_restart_parameters optional	Graceful Restart parameters	GracefulRestartParametersType
fast_convergence_parameters optional	Fast Convergence parameters.	FastConvergenceParametersType
plugin_tuning optional	Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.	PluginProperties
data_center_interconnect_loopback_namespace optional	Used for assigning loopback addresses on interconnect physical devices.	SubnetListType
data_center_interconnect_asn_namespace optional	Used for assigning asn values on interconnect physical devices.	AsnRangeType
ibgp_auto_mesh optional	When true, system will automatically create BGP peering mesh with all control-nodes that have same BGP AS number as global AS number.	boolean
bgp_always_compare_med optional	Always compare MED even if paths are received from different ASes.	boolean
rd_cluster_seed optional	Used to create collision-free route distinguishers.	number
route_replication_threshold optional	Time to wait (in minutes) before enabling optimisation in route replication.	number
ip_fabric_subnets optional	List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic GRE tunnels on the SDN gateway.	SubnetListType
supported_device_families optional	List of all supported physical router device family names. Used by UI to show pick list.	DeviceFamilyListType
supported_vendor_hardwares optional	List of all supported vendor hardware platforms by the system. Used by UI to show pick list.	VendorHardwaresType
bgpaas_parameters optional	BGP As A Service Parameters configuration	BGPaaServiceParametersType
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
igmp_enable optional	IGMP mode at Global level.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
user_defined_log_statistics optional	stats name and patterns	UserDefinedLogStatList
enable_security_policy_draft optional		boolean
supported_fabric_annotations optional	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.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
bgp_router_refs optional	List of bgp-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
qos_config_back_refs optional	List of qos-config references	ResourceReference array

GlobalSystemConfigUpdate

Name	Description	Schema
autonomous_system optional	Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits by setting enable-4byte-as.	number
enable_4byte_as optional	Knob to enable 4 byte Autonomous System number support.	boolean
graceful_restart_parameters optional	Graceful Restart parameters	GracefulRestartParametersType
fast_convergence_parameters optional	Fast Convergence parameters.	FastConvergenceParametersType
plugin_tuning optional	Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.	PluginProperties
data_center_interconnect_loopback_namespace optional	Used for assigning loopback addresses on interconnect physical devices.	SubnetListType
data_center_interconnect_asn_namespace optional	Used for assigning asn values on interconnect physical devices.	AsnRangeType
ibgp_auto_mesh optional	When true, system will automatically create BGP peering mesh with all control-nodes that have same BGP AS number as global AS number.	boolean
bgp_always_compare_med optional	Always compare MED even if paths are received from different ASes.	boolean
rd_cluster_seed optional	Used to create collision-free route distinguishers.	number
route_replication_threshold optional	Time to wait (in minutes) before enabling optimisation in route replication.	number
ip_fabric_subnets optional	List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic GRE tunnels on the SDN gateway.	SubnetListType
supported_device_families optional	List of all supported physical router device family names. Used by UI to show pick list.	DeviceFamilyListType
supported_vendor_hardwares optional	List of all supported vendor hardware platforms by the system. Used by UI to show pick list.	VendorHardwaresType
bgpaas_parameters optional	BGP As A Service Parameters configuration	BGPaaServiceParametersType
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
igmp_enable optional	IGMP mode at Global level.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
user_defined_log_statistics optional	stats name and patterns	UserDefinedLogStatList
enable_security_policy_draft optional		boolean
supported_fabric_annotations optional	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.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalVrouterConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
linklocal_services optional	Global services provided on link local subnet to the virtual machines.	LinklocalServicesTypes
encapsulation_priorities optional	Ordered list of encapsulations that vrouter will use in priority order.	EncapsulationPrioritiesType
vxlan_network_identifier_mode optional	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.	Any of [‘configured’, ‘automatic’]
flow_export_rate optional	Flow export rate is global config, rate at which each vrouter will sample and export flow records to analytics	number
flow_aging_timeout_list optional	Flow aging timeout per application (protocol, port) list.	FlowAgingTimeoutList
enable_security_logging optional	Enable or disable security-logging in the system	boolean
encryption_mode optional	Enable encryption mode	Any of [‘none’, ‘all’]
encryption_tunnel_endpoints optional	Encryption tunnel endpoints list	EncryptionTunnelEndpointList
forwarding_mode optional	Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.	Any of [‘l2_l3’, ‘l2’, ‘l3’]
port_translation_pools optional	List of Ports to be reserved for providing underlay connectivity via Port translation.	PortTranslationPools
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalVrouterConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
linklocal_services optional	Global services provided on link local subnet to the virtual machines.	LinklocalServicesTypes
encapsulation_priorities optional	Ordered list of encapsulations that vrouter will use in priority order.	EncapsulationPrioritiesType
vxlan_network_identifier_mode optional	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.	Any of [‘configured’, ‘automatic’]
flow_export_rate optional	Flow export rate is global config, rate at which each vrouter will sample and export flow records to analytics	number
flow_aging_timeout_list optional	Flow aging timeout per application (protocol, port) list.	FlowAgingTimeoutList
enable_security_logging optional	Enable or disable security-logging in the system	boolean
encryption_mode optional	Enable encryption mode	Any of [‘none’, ‘all’]
encryption_tunnel_endpoints optional	Encryption tunnel endpoints list	EncryptionTunnelEndpointList
forwarding_mode optional	Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.	Any of [‘l2_l3’, ‘l2’, ‘l3’]
port_translation_pools optional	List of Ports to be reserved for providing underlay connectivity via Port translation.	PortTranslationPools
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GlobalVrouterConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
linklocal_services optional	Global services provided on link local subnet to the virtual machines.	LinklocalServicesTypes
encapsulation_priorities optional	Ordered list of encapsulations that vrouter will use in priority order.	EncapsulationPrioritiesType
vxlan_network_identifier_mode optional	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.	Any of [‘configured’, ‘automatic’]
flow_export_rate optional	Flow export rate is global config, rate at which each vrouter will sample and export flow records to analytics	number
flow_aging_timeout_list optional	Flow aging timeout per application (protocol, port) list.	FlowAgingTimeoutList
enable_security_logging optional	Enable or disable security-logging in the system	boolean
encryption_mode optional	Enable encryption mode	Any of [‘none’, ‘all’]
encryption_tunnel_endpoints optional	Encryption tunnel endpoints list	EncryptionTunnelEndpointList
forwarding_mode optional	Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.	Any of [‘l2_l3’, ‘l2’, ‘l3’]
port_translation_pools optional	List of Ports to be reserved for providing underlay connectivity via Port translation.	PortTranslationPools
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
application_policy_set_back_refs optional	List of application-policy-set references	ResourceReference array

GlobalVrouterConfigUpdate

Name	Description	Schema
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
linklocal_services optional	Global services provided on link local subnet to the virtual machines.	LinklocalServicesTypes
encapsulation_priorities optional	Ordered list of encapsulations that vrouter will use in priority order.	EncapsulationPrioritiesType
vxlan_network_identifier_mode optional	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.	Any of [‘configured’, ‘automatic’]
flow_export_rate optional	Flow export rate is global config, rate at which each vrouter will sample and export flow records to analytics	number
flow_aging_timeout_list optional	Flow aging timeout per application (protocol, port) list.	FlowAgingTimeoutList
enable_security_logging optional	Enable or disable security-logging in the system	boolean
encryption_mode optional	Enable encryption mode	Any of [‘none’, ‘all’]
encryption_tunnel_endpoints optional	Encryption tunnel endpoints list	EncryptionTunnelEndpointList
forwarding_mode optional	Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.	Any of [‘l2_l3’, ‘l2’, ‘l3’]
port_translation_pools optional	List of Ports to be reserved for providing underlay connectivity via Port translation.	PortTranslationPools
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GrpcProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
grpc_profile_is_default optional	This attribute indicates whether it is a default grpc profile or not. Default profiles are non- editable.	boolean
grpc_parameters optional	Parameters for each grpc profile, such as allow client, top level sensor options etc.	GrpcParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GrpcProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
grpc_profile_is_default optional	This attribute indicates whether it is a default grpc profile or not. Default profiles are non- editable.	boolean
grpc_parameters optional	Parameters for each grpc profile, such as allow client, top level sensor options etc.	GrpcParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

GrpcProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
grpc_profile_is_default optional	This attribute indicates whether it is a default grpc profile or not. Default profiles are non- editable.	boolean
grpc_parameters optional	Parameters for each grpc profile, such as allow client, top level sensor options etc.	GrpcParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
telemetry_profile_back_refs optional	List of telemetry-profile references	ResourceReference array

GrpcProfileUpdate

Name	Description	Schema
grpc_profile_is_default optional	This attribute indicates whether it is a default grpc profile or not. Default profiles are non- editable.	boolean
grpc_parameters optional	Parameters for each grpc profile, such as allow client, top level sensor options etc.	GrpcParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

HardwareCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
card_refs optional	List of card references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

HardwareReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
card_refs optional	List of card references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

HardwareReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
card_refs optional	List of card references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
node_profile_back_refs optional	List of node-profile references	ResourceReference array
device_image_back_refs optional	List of device-image references	ResourceReference array

HardwareUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
card_refs optional	List of card references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

HardwareInventoryCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘physical-router’]
hardware_inventory_inventory_info optional	chassis inventory info of the physical router. Stored as json string. Will be used to render chassis hardware details in UI	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

HardwareInventoryReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
hardware_inventory_inventory_info optional	chassis inventory info of the physical router. Stored as json string. Will be used to render chassis hardware details in UI	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

HardwareInventoryReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
hardware_inventory_inventory_info optional	chassis inventory info of the physical router. Stored as json string. Will be used to render chassis hardware details in UI	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

HardwareInventoryUpdate

Name	Description	Schema
hardware_inventory_inventory_info optional	chassis inventory info of the physical router. Stored as json string. Will be used to render chassis hardware details in UI	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

HostBasedServiceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
host_based_service_type optional	Defines which host based service type is used, cannot not be updated.	Any of [‘firewall’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

HostBasedServiceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
host_based_service_type optional	Defines which host based service type is used, cannot not be updated.	Any of [‘firewall’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	HostBasedServiceVirtualNetworkRefs array
tag_refs optional	List of tag references	ResourceReference array

HostBasedServiceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
host_based_service_type optional	Defines which host based service type is used, cannot not be updated.	Any of [‘firewall’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	HostBasedServiceVirtualNetworkRefs array
tag_refs optional	List of tag references	ResourceReference array

HostBasedServiceUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

InstanceIpCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
instance_ip_address required	Ip address value for instance ip.	string
instance_ip_family optional	Ip address family for instance ip, IPv4(v4) or IPv6(v6).	Any of [‘v4’, ‘v6’]
instance_ip_mode optional	Ip address HA mode in case this instance ip is used in more than one interface, active-Active or active-Standby.	Any of [‘active-active’, ‘active-standby’]
secondary_ip_tracking_ip optional	When this instance ip is secondary ip, it can track activeness of another ip.	SubnetType
subnet_uuid optional	This instance ip was allocated from this Subnet(UUID).	string
instance_ip_subscriber_tag optional	This instance ip belongs to one of the subscribers in the subscriber-tag.	string
instance_ip_secondary optional	This instance ip is secondary ip of the interface.	boolean
instance_ip_local_ip optional	This instance ip is local to compute and will not be exported to other nodes.	boolean
service_instance_ip optional	This instance ip is used as service chain next hop	boolean
service_health_check_ip optional	This instance ip is used as service health check source ip	boolean
instance_ip_subnet optional	Ip prefix/length of the subnet where instance-ip belongs.	SubnetType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs required	List of virtual-network references	ResourceReference array
network_ipam_refs required	List of network-ipam references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
virtual_router_refs optional	List of virtual-router references	ResourceReference array
logical_interface_refs optional	List of logical-interface references	ResourceReference array
flow_node_refs optional	List of flow-node references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

InstanceIpReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
instance_ip_address optional	Ip address value for instance ip.	string
instance_ip_family optional	Ip address family for instance ip, IPv4(v4) or IPv6(v6).	Any of [‘v4’, ‘v6’]
instance_ip_mode optional	Ip address HA mode in case this instance ip is used in more than one interface, active-Active or active-Standby.	Any of [‘active-active’, ‘active-standby’]
secondary_ip_tracking_ip optional	When this instance ip is secondary ip, it can track activeness of another ip.	SubnetType
subnet_uuid optional	This instance ip was allocated from this Subnet(UUID).	string
instance_ip_subscriber_tag optional	This instance ip belongs to one of the subscribers in the subscriber-tag.	string
instance_ip_secondary optional	This instance ip is secondary ip of the interface.	boolean
instance_ip_local_ip optional	This instance ip is local to compute and will not be exported to other nodes.	boolean
service_instance_ip optional	This instance ip is used as service chain next hop	boolean
service_health_check_ip optional	This instance ip is used as service health check source ip	boolean
instance_ip_subnet optional	Ip prefix/length of the subnet where instance-ip belongs.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
network_ipam_refs optional	List of network-ipam references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
virtual_router_refs optional	List of virtual-router references	ResourceReference array
logical_interface_refs optional	List of logical-interface references	ResourceReference array
flow_node_refs optional	List of flow-node references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

InstanceIpReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
instance_ip_address optional	Ip address value for instance ip.	string
instance_ip_family optional	Ip address family for instance ip, IPv4(v4) or IPv6(v6).	Any of [‘v4’, ‘v6’]
instance_ip_mode optional	Ip address HA mode in case this instance ip is used in more than one interface, active-Active or active-Standby.	Any of [‘active-active’, ‘active-standby’]
secondary_ip_tracking_ip optional	When this instance ip is secondary ip, it can track activeness of another ip.	SubnetType
subnet_uuid optional	This instance ip was allocated from this Subnet(UUID).	string
instance_ip_subscriber_tag optional	This instance ip belongs to one of the subscribers in the subscriber-tag.	string
instance_ip_secondary optional	This instance ip is secondary ip of the interface.	boolean
instance_ip_local_ip optional	This instance ip is local to compute and will not be exported to other nodes.	boolean
service_instance_ip optional	This instance ip is used as service chain next hop	boolean
service_health_check_ip optional	This instance ip is used as service health check source ip	boolean
instance_ip_subnet optional	Ip prefix/length of the subnet where instance-ip belongs.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
network_ipam_refs optional	List of network-ipam references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
virtual_router_refs optional	List of virtual-router references	ResourceReference array
logical_interface_refs optional	List of logical-interface references	ResourceReference array
flow_node_refs optional	List of flow-node references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
service_instance_back_refs optional	List of service-instance back references	ServiceInstanceInstanceIpRefs array

InstanceIpUpdate

Name	Description	Schema
secondary_ip_tracking_ip optional	When this instance ip is secondary ip, it can track activeness of another ip.	SubnetType
instance_ip_secondary optional	This instance ip is secondary ip of the interface.	boolean
instance_ip_local_ip optional	This instance ip is local to compute and will not be exported to other nodes.	boolean
service_instance_ip optional	This instance ip is used as service chain next hop	boolean
service_health_check_ip optional	This instance ip is used as service health check source ip	boolean
instance_ip_subnet optional	Ip prefix/length of the subnet where instance-ip belongs.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_network_refs optional	List of virtual-network references	ResourceReference array
network_ipam_refs optional	List of network-ipam references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
virtual_router_refs optional	List of virtual-router references	ResourceReference array
logical_interface_refs optional	List of logical-interface references	ResourceReference array
flow_node_refs optional	List of flow-node references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

IntentMapCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
intent_map_intent_type optional	Based on this value we determine what intent model we are serving	Any of [‘assisted-replicator’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

IntentMapReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
intent_map_intent_type optional	Based on this value we determine what intent model we are serving	Any of [‘assisted-replicator’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

IntentMapReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
intent_map_intent_type optional	Based on this value we determine what intent model we are serving	Any of [‘assisted-replicator’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
fabric_back_refs optional	List of fabric references	ResourceReference array

IntentMapUpdate

Name	Description	Schema
intent_map_intent_type optional	Based on this value we determine what intent model we are serving	Any of [‘assisted-replicator’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

InterfaceRouteTableCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
interface_route_table_routes required	Interface route table used same structure as route table, however the next hop field is irrelevant.	RouteTableType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	InterfaceRouteTableServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

InterfaceRouteTableReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
interface_route_table_routes optional	Interface route table used same structure as route table, however the next hop field is irrelevant.	RouteTableType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	InterfaceRouteTableServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

InterfaceRouteTableReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
interface_route_table_routes optional	Interface route table used same structure as route table, however the next hop field is irrelevant.	RouteTableType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	InterfaceRouteTableServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array
routing_policy_back_refs optional	List of routing-policy references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array

InterfaceRouteTableUpdate

Name	Description	Schema
interface_route_table_routes optional	Interface route table used same structure as route table, however the next hop field is irrelevant.	RouteTableType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	InterfaceRouteTableServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

JobTemplateCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
job_template_synchronous_job required	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’.	boolean
job_template_type required	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)	Any of [‘workflow’, ‘device_operation’, ‘config’, ‘executable’]
job_template_concurrency_level required	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.	Any of [‘fabric’, ‘device’]
job_template_playbooks required	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	PlaybookInfoListType
job_template_recovery_playbooks optional	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	PlaybookInfoListType
job_template_executables optional	List of Executables that needs to be Executed	ExecutableInfoListType
job_template_input_schema optional	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’]}	string
job_template_output_schema optional	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.	string
job_template_input_ui_schema optional	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.	string
job_template_output_ui_schema optional	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.	string
job_template_description optional	A detailed description of what the job template functionality is	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

JobTemplateReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
job_template_synchronous_job optional	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’.	boolean
job_template_type optional	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)	Any of [‘workflow’, ‘device_operation’, ‘config’, ‘executable’]
job_template_concurrency_level optional	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.	Any of [‘fabric’, ‘device’]
job_template_playbooks optional	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	PlaybookInfoListType
job_template_recovery_playbooks optional	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	PlaybookInfoListType
job_template_executables optional	List of Executables that needs to be Executed	ExecutableInfoListType
job_template_input_schema optional	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’]}	string
job_template_output_schema optional	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.	string
job_template_input_ui_schema optional	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.	string
job_template_output_ui_schema optional	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.	string
job_template_description optional	A detailed description of what the job template functionality is	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

JobTemplateReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
job_template_synchronous_job optional	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’.	boolean
job_template_type optional	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)	Any of [‘workflow’, ‘device_operation’, ‘config’, ‘executable’]
job_template_concurrency_level optional	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.	Any of [‘fabric’, ‘device’]
job_template_playbooks optional	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	PlaybookInfoListType
job_template_recovery_playbooks optional	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	PlaybookInfoListType
job_template_executables optional	List of Executables that needs to be Executed	ExecutableInfoListType
job_template_input_schema optional	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’]}	string
job_template_output_schema optional	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.	string
job_template_input_ui_schema optional	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.	string
job_template_output_ui_schema optional	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.	string
job_template_description optional	A detailed description of what the job template functionality is	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
node_profile_back_refs optional	List of node-profile references	ResourceReference array

JobTemplateUpdate

Name	Description	Schema
job_template_synchronous_job optional	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’.	boolean
job_template_type optional	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)	Any of [‘workflow’, ‘device_operation’, ‘config’, ‘executable’]
job_template_concurrency_level optional	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.	Any of [‘fabric’, ‘device’]
job_template_playbooks optional	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	PlaybookInfoListType
job_template_recovery_playbooks optional	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	PlaybookInfoListType
job_template_executables optional	List of Executables that needs to be Executed	ExecutableInfoListType
job_template_input_schema optional	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’]}	string
job_template_output_schema optional	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.	string
job_template_input_ui_schema optional	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.	string
job_template_output_ui_schema optional	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.	string
job_template_description optional	A detailed description of what the job template functionality is	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LinkAggregationGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘physical-router’]
link_aggregation_group_lacp_enabled required	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LinkAggregationGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
link_aggregation_group_lacp_enabled optional	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LinkAggregationGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
link_aggregation_group_lacp_enabled optional	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LinkAggregationGroupUpdate

Name	Description	Schema
link_aggregation_group_lacp_enabled optional	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
loadbalancer_properties required	Loadbalancer configuration like admin state, VIP, VIP subnet etc.	LoadbalancerType
loadbalancer_provider optional	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.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_properties optional	Loadbalancer configuration like admin state, VIP, VIP subnet etc.	LoadbalancerType
loadbalancer_provider optional	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.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_properties optional	Loadbalancer configuration like admin state, VIP, VIP subnet etc.	LoadbalancerType
loadbalancer_provider optional	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.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
loadbalancer_listener_back_refs optional	List of loadbalancer-listener references	ResourceReference array

LoadbalancerUpdate

Name	Description	Schema
loadbalancer_properties optional	Loadbalancer configuration like admin state, VIP, VIP subnet etc.	LoadbalancerType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerHealthmonitorCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
loadbalancer_healthmonitor_properties required	Configuration parameters for health monitor like type, method, retries etc.	LoadbalancerHealthmonitorType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerHealthmonitorReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_healthmonitor_properties optional	Configuration parameters for health monitor like type, method, retries etc.	LoadbalancerHealthmonitorType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerHealthmonitorReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_healthmonitor_properties optional	Configuration parameters for health monitor like type, method, retries etc.	LoadbalancerHealthmonitorType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
loadbalancer_pool_back_refs optional	List of loadbalancer-pool references	ResourceReference array

LoadbalancerHealthmonitorUpdate

Name	Description	Schema
loadbalancer_healthmonitor_properties optional	Configuration parameters for health monitor like type, method, retries etc.	LoadbalancerHealthmonitorType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerListenerCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
loadbalancer_listener_properties optional		LoadbalancerListenerType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_refs optional	List of loadbalancer references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerListenerReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_listener_properties optional		LoadbalancerListenerType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_refs optional	List of loadbalancer references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerListenerReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_listener_properties optional		LoadbalancerListenerType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_refs optional	List of loadbalancer references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
loadbalancer_pool_back_refs optional	List of loadbalancer-pool references	ResourceReference array

LoadbalancerListenerUpdate

Name	Description	Schema
loadbalancer_listener_properties optional		LoadbalancerListenerType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_refs optional	List of loadbalancer references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerMemberCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘loadbalancer-pool’]
loadbalancer_member_properties required	Member configuration like ip address, destination port, weight etc.	LoadbalancerMemberType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerMemberReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_member_properties optional	Member configuration like ip address, destination port, weight etc.	LoadbalancerMemberType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerMemberReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_member_properties optional	Member configuration like ip address, destination port, weight etc.	LoadbalancerMemberType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerMemberUpdate

Name	Description	Schema
loadbalancer_member_properties optional	Member configuration like ip address, destination port, weight etc.	LoadbalancerMemberType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerPoolCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
loadbalancer_pool_properties required	Configuration for loadbalancer pool like protocol, subnet, etc.	LoadbalancerPoolType
loadbalancer_pool_provider optional	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	string
loadbalancer_pool_custom_attributes optional	Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable to LBaaS V1.	KeyValuePairs
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
loadbalancer_listener_refs optional	List of loadbalancer-listener references	ResourceReference array
loadbalancer_healthmonitor_refs optional	List of loadbalancer-healthmonitor references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerPoolReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_pool_properties optional	Configuration for loadbalancer pool like protocol, subnet, etc.	LoadbalancerPoolType
loadbalancer_pool_provider optional	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	string
loadbalancer_pool_custom_attributes optional	Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable to LBaaS V1.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
loadbalancer_listener_refs optional	List of loadbalancer-listener references	ResourceReference array
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
loadbalancer_healthmonitor_refs optional	List of loadbalancer-healthmonitor references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LoadbalancerPoolReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
loadbalancer_pool_properties optional	Configuration for loadbalancer pool like protocol, subnet, etc.	LoadbalancerPoolType
loadbalancer_pool_provider optional	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	string
loadbalancer_pool_custom_attributes optional	Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable to LBaaS V1.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
loadbalancer_listener_refs optional	List of loadbalancer-listener references	ResourceReference array
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
loadbalancer_healthmonitor_refs optional	List of loadbalancer-healthmonitor references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_ip_back_refs optional	List of virtual-ip references	ResourceReference array

LoadbalancerPoolUpdate

Name	Description	Schema
loadbalancer_pool_properties optional	Configuration for loadbalancer pool like protocol, subnet, etc.	LoadbalancerPoolType
loadbalancer_pool_custom_attributes optional	Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable to LBaaS V1.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_listener_refs optional	List of loadbalancer-listener references	ResourceReference array
loadbalancer_healthmonitor_refs optional	List of loadbalancer-healthmonitor references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LogicalInterfaceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘physical-router’, ‘physical-interface’]
logical_interface_vlan_tag optional	VLAN tag (.1Q) classifier for this logical interface.	number
logical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
logical_interface_type optional	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.	Any of [‘l2’, ‘l3’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LogicalInterfaceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
logical_interface_vlan_tag optional	VLAN tag (.1Q) classifier for this logical interface.	number
logical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
logical_interface_type optional	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.	Any of [‘l2’, ‘l3’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LogicalInterfaceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
logical_interface_vlan_tag optional	VLAN tag (.1Q) classifier for this logical interface.	number
logical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
logical_interface_type optional	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.	Any of [‘l2’, ‘l3’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array

LogicalInterfaceUpdate

Name	Description	Schema
logical_interface_vlan_tag optional	VLAN tag (.1Q) classifier for this logical interface.	number
logical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
logical_interface_type optional	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.	Any of [‘l2’, ‘l3’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LogicalRouterCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
configured_route_target_list optional	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.	RouteTargetList
vxlan_network_identifier optional	The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.	string
logical_router_dhcp_relay_server optional	DHCP server IP(s) to serve managed BMS(s).	IpAddressesType
logical_router_gateway_external required	this logical router is used for external connectivity or not.	boolean
logical_router_type optional	Type of logical-router, used to signify the purpose of the logical-router.	Any of [‘snat-routing’, ‘vxlan-routing’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
route_target_refs optional	List of route-target references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	LogicalRouterVirtualNetworkRefs array
service_instance_refs optional	List of service-instance references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LogicalRouterReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
configured_route_target_list optional	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.	RouteTargetList
vxlan_network_identifier optional	The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.	string
logical_router_dhcp_relay_server optional	DHCP server IP(s) to serve managed BMS(s).	IpAddressesType
logical_router_gateway_external optional	this logical router is used for external connectivity or not.	boolean
logical_router_type optional	Type of logical-router, used to signify the purpose of the logical-router.	Any of [‘snat-routing’, ‘vxlan-routing’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
route_target_refs optional	List of route-target references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	LogicalRouterVirtualNetworkRefs array
service_instance_refs optional	List of service-instance references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

LogicalRouterReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
configured_route_target_list optional	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.	RouteTargetList
vxlan_network_identifier optional	The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.	string
logical_router_dhcp_relay_server optional	DHCP server IP(s) to serve managed BMS(s).	IpAddressesType
logical_router_gateway_external optional	this logical router is used for external connectivity or not.	boolean
logical_router_type optional	Type of logical-router, used to signify the purpose of the logical-router.	Any of [‘snat-routing’, ‘vxlan-routing’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
route_target_refs optional	List of route-target references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	LogicalRouterVirtualNetworkRefs array
service_instance_refs optional	List of service-instance references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
port_tuple_back_refs optional	List of port-tuple references	ResourceReference array
data_center_interconnect_back_refs optional	List of data-center-interconnect references	ResourceReference array

LogicalRouterUpdate

Name	Description	Schema
configured_route_target_list optional	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.	RouteTargetList
vxlan_network_identifier optional	The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.	string
logical_router_dhcp_relay_server optional	DHCP server IP(s) to serve managed BMS(s).	IpAddressesType
logical_router_gateway_external optional	this logical router is used for external connectivity or not.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
route_target_refs optional	List of route-target references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	LogicalRouterVirtualNetworkRefs array
service_instance_refs optional	List of service-instance references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

MulticastPolicyCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
multicast_source_groups optional	List of Multicast (S,G) Addresses.	MulticastSourceGroups
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

MulticastPolicyReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
multicast_source_groups optional	List of Multicast (S,G) Addresses.	MulticastSourceGroups
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

MulticastPolicyReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
multicast_source_groups optional	List of Multicast (S,G) Addresses.	MulticastSourceGroups
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array

MulticastPolicyUpdate

Name	Description	Schema
multicast_source_groups optional	List of Multicast (S,G) Addresses.	MulticastSourceGroups
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NamespaceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘domain’]
namespace_cidr optional	All networks in this namespace belong to this list of Prefixes. Not implemented.	SubnetType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NamespaceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
namespace_cidr optional	All networks in this namespace belong to this list of Prefixes. Not implemented.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NamespaceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
namespace_cidr optional	All networks in this namespace belong to this list of Prefixes. Not implemented.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
project_back_refs optional	List of project back references	ProjectNamespaceRefs array

NamespaceUpdate

Name	Description	Schema
namespace_cidr optional	All networks in this namespace belong to this list of Prefixes. Not implemented.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NetconfProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
netconf_profile_is_default optional	This attribute indicates whether it is a default netconf profile or not. Default profiles are non- editable.	boolean
netconf_parameters optional	Parameters for each netconf profile like the top level sensor options etc.	NetconfParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NetconfProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
netconf_profile_is_default optional	This attribute indicates whether it is a default netconf profile or not. Default profiles are non- editable.	boolean
netconf_parameters optional	Parameters for each netconf profile like the top level sensor options etc.	NetconfParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NetconfProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
netconf_profile_is_default optional	This attribute indicates whether it is a default netconf profile or not. Default profiles are non- editable.	boolean
netconf_parameters optional	Parameters for each netconf profile like the top level sensor options etc.	NetconfParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
telemetry_profile_back_refs optional	List of telemetry-profile references	ResourceReference array

NetconfProfileUpdate

Name	Description	Schema
netconf_profile_is_default optional	This attribute indicates whether it is a default netconf profile or not. Default profiles are non- editable.	boolean
netconf_parameters optional	Parameters for each netconf profile like the top level sensor options etc.	NetconfParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NetworkDeviceConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkDeviceConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkDeviceConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkDeviceConfigUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_router_refs optional	List of physical-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkIpamCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
network_ipam_mgmt optional	Network IP Address Management configuration.	IpamType
ipam_subnets optional	List of subnets for this ipam.	IpamSubnets
ipam_subnet_method optional	Subnet method configuration for ipam, user can configure user-defined, flat or auto.	Any of [‘user-defined-subnet’, ‘flat-subnet’, ‘auto-subnet’]
ipam_subnetting optional	This flag indicates if ipam subnets are carved out from a big subnet, default behavior is False.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_DNS_refs optional	List of virtual-DNS references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkIpamReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
network_ipam_mgmt optional	Network IP Address Management configuration.	IpamType
ipam_subnets optional	List of subnets for this ipam.	IpamSubnets
ipam_subnet_method optional	Subnet method configuration for ipam, user can configure user-defined, flat or auto.	Any of [‘user-defined-subnet’, ‘flat-subnet’, ‘auto-subnet’]
ipam_subnetting optional	This flag indicates if ipam subnets are carved out from a big subnet, default behavior is False.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_DNS_refs optional	List of virtual-DNS references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkIpamReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
network_ipam_mgmt optional	Network IP Address Management configuration.	IpamType
ipam_subnets optional	List of subnets for this ipam.	IpamSubnets
ipam_subnet_method optional	Subnet method configuration for ipam, user can configure user-defined, flat or auto.	Any of [‘user-defined-subnet’, ‘flat-subnet’, ‘auto-subnet’]
ipam_subnetting optional	This flag indicates if ipam subnets are carved out from a big subnet, default behavior is False.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_DNS_refs optional	List of virtual-DNS references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network back references	VirtualNetworkNetworkIpamRefs array
virtual_router_back_refs optional	List of virtual-router back references	VirtualRouterNetworkIpamRefs array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array

NetworkIpamUpdate

Name	Description	Schema
network_ipam_mgmt optional	Network IP Address Management configuration.	IpamType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_DNS_refs optional	List of virtual-DNS references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NetworkPolicyCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
network_policy_entries required	Network policy rule entries.	PolicyEntriesType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NetworkPolicyReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
network_policy_entries optional	Network policy rule entries.	PolicyEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NetworkPolicyReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
network_policy_entries optional	Network policy rule entries.	PolicyEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
security_logging_object_back_refs optional	List of security-logging-object back references	SecurityLoggingObjectNetworkPolicyRefs array
virtual_network_back_refs optional	List of virtual-network back references	VirtualNetworkNetworkPolicyRefs array

NetworkPolicyUpdate

Name	Description	Schema
network_policy_entries optional	Network policy rule entries.	PolicyEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

NodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
node_type optional	Type of machine resource	Any of [‘private’, ‘baremetal’, ‘esxi’, ‘ovs-compute’, ‘sriov-compute’]
esxi_info optional	Details of the ESXI host	ESXIHostInfo
ip_address optional	IP Address of the Management interface	string
hostname optional	Fully qualified host name	string
bms_info optional	Details of the baremetal server	BaremetalServerInfo
mac_address optional	Provisioning Interface MAC Address	string
disk_partition optional	Comma seperated disk partition to use.	string
interface_name optional	Name of the Management interface	string
cloud_info optional	Information related to cloud	CloudInstanceInfo
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
node_profile_refs optional	List of node-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
node_type optional	Type of machine resource	Any of [‘private’, ‘baremetal’, ‘esxi’, ‘ovs-compute’, ‘sriov-compute’]
esxi_info optional	Details of the ESXI host	ESXIHostInfo
ip_address optional	IP Address of the Management interface	string
hostname optional	Fully qualified host name	string
bms_info optional	Details of the baremetal server	BaremetalServerInfo
mac_address optional	Provisioning Interface MAC Address	string
disk_partition optional	Comma seperated disk partition to use.	string
interface_name optional	Name of the Management interface	string
cloud_info optional	Information related to cloud	CloudInstanceInfo
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
node_profile_refs optional	List of node-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
node_type optional	Type of machine resource	Any of [‘private’, ‘baremetal’, ‘esxi’, ‘ovs-compute’, ‘sriov-compute’]
esxi_info optional	Details of the ESXI host	ESXIHostInfo
ip_address optional	IP Address of the Management interface	string
hostname optional	Fully qualified host name	string
bms_info optional	Details of the baremetal server	BaremetalServerInfo
mac_address optional	Provisioning Interface MAC Address	string
disk_partition optional	Comma seperated disk partition to use.	string
interface_name optional	Name of the Management interface	string
cloud_info optional	Information related to cloud	CloudInstanceInfo
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
node_profile_refs optional	List of node-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NodeUpdate

Name	Description	Schema
node_type optional	Type of machine resource	Any of [‘private’, ‘baremetal’, ‘esxi’, ‘ovs-compute’, ‘sriov-compute’]
esxi_info optional	Details of the ESXI host	ESXIHostInfo
ip_address optional	IP Address of the Management interface	string
hostname optional	Fully qualified host name	string
bms_info optional	Details of the baremetal server	BaremetalServerInfo
mac_address optional	Provisioning Interface MAC Address	string
disk_partition optional	Comma seperated disk partition to use.	string
interface_name optional	Name of the Management interface	string
cloud_info optional	Information related to cloud	CloudInstanceInfo
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
node_profile_refs optional	List of node-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NodeProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
node_profile_type optional	Node profile type to differentiate the node profile network devices from server node profiles.	Any of [‘physical-router’, ‘end-system’]
node_profile_vendor required	Vendor name (e.g. Juniper) that this node profile can be used for.	string
node_profile_device_family required	Device family name that this node profile can be used to match.	string
node_profile_hitless_upgrade required	if set to false, do not perform hitless image upgrade on devices using this node profile	boolean
node_profile_roles required	List of capable physical and routing-bridging role combinations supported by the devices that matches one of the hardware list defined in this node profile.	NodeProfileRolesType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
job_template_refs optional	List of job-template references	ResourceReference array
hardware_refs optional	List of hardware references	ResourceReference array
role_definition_refs optional	List of role-definition references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NodeProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
node_profile_type optional	Node profile type to differentiate the node profile network devices from server node profiles.	Any of [‘physical-router’, ‘end-system’]
node_profile_vendor optional	Vendor name (e.g. Juniper) that this node profile can be used for.	string
node_profile_device_family optional	Device family name that this node profile can be used to match.	string
node_profile_hitless_upgrade optional	if set to false, do not perform hitless image upgrade on devices using this node profile	boolean
node_profile_roles optional	List of capable physical and routing-bridging role combinations supported by the devices that matches one of the hardware list defined in this node profile.	NodeProfileRolesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
job_template_refs optional	List of job-template references	ResourceReference array
hardware_refs optional	List of hardware references	ResourceReference array
role_definition_refs optional	List of role-definition references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

NodeProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
node_profile_type optional	Node profile type to differentiate the node profile network devices from server node profiles.	Any of [‘physical-router’, ‘end-system’]
node_profile_vendor optional	Vendor name (e.g. Juniper) that this node profile can be used for.	string
node_profile_device_family optional	Device family name that this node profile can be used to match.	string
node_profile_hitless_upgrade optional	if set to false, do not perform hitless image upgrade on devices using this node profile	boolean
node_profile_roles optional	List of capable physical and routing-bridging role combinations supported by the devices that matches one of the hardware list defined in this node profile.	NodeProfileRolesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
job_template_refs optional	List of job-template references	ResourceReference array
hardware_refs optional	List of hardware references	ResourceReference array
role_definition_refs optional	List of role-definition references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
fabric_back_refs optional	List of fabric back references	FabricNodeProfileRefs array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
node_back_refs optional	List of node references	ResourceReference array

NodeProfileUpdate

Name	Description	Schema
node_profile_type optional	Node profile type to differentiate the node profile network devices from server node profiles.	Any of [‘physical-router’, ‘end-system’]
node_profile_vendor optional	Vendor name (e.g. Juniper) that this node profile can be used for.	string
node_profile_device_family optional	Device family name that this node profile can be used to match.	string
node_profile_hitless_upgrade optional	if set to false, do not perform hitless image upgrade on devices using this node profile	boolean
node_profile_roles optional	List of capable physical and routing-bridging role combinations supported by the devices that matches one of the hardware list defined in this node profile.	NodeProfileRolesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
job_template_refs optional	List of job-template references	ResourceReference array
hardware_refs optional	List of hardware references	ResourceReference array
role_definition_refs optional	List of role-definition references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

OverlayRoleCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

OverlayRoleReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

OverlayRoleReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
role_definition_back_refs optional	List of role-definition references	ResourceReference array

OverlayRoleUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PeeringPolicyCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
peering_service required	Peering policy service type.	Any of [‘public-peering’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PeeringPolicyReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
peering_service optional	Peering policy service type.	Any of [‘public-peering’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PeeringPolicyReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
peering_service optional	Peering policy service type.	Any of [‘public-peering’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
e2_service_provider_back_refs optional	List of e2-service-provider references	ResourceReference array

PeeringPolicyUpdate

Name	Description	Schema
peering_service optional	Peering policy service type.	Any of [‘public-peering’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PhysicalInterfaceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘physical-router’]
ethernet_segment_identifier optional	Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should configure the peer Physical interface with the same ESI.	string
physical_interface_type optional	Physical interface type that can be either regular/LAG/service/fabric/access link.	Any of [‘regular’, ‘lag’, ‘service’, ‘fabric’, ‘access’]
physical_interface_mac_addresses optional	MAC addresses on this physical interface.	MacAddressesType
physical_interface_port_id optional	port id of this physical interface. This port id is used in LLDP to identify a physical port on the peering device	string
physical_interface_flow_control optional	User can enable this option to configure flow control on the physical interface.	boolean
physical_interface_lacp_force_up optional	User can enable this option to make LACP up and running. This is applicable only on individual member physical interfaces of a VPG.	boolean
physical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PhysicalInterfaceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ethernet_segment_identifier optional	Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should configure the peer Physical interface with the same ESI.	string
physical_interface_type optional	Physical interface type that can be either regular/LAG/service/fabric/access link.	Any of [‘regular’, ‘lag’, ‘service’, ‘fabric’, ‘access’]
physical_interface_mac_addresses optional	MAC addresses on this physical interface.	MacAddressesType
physical_interface_port_id optional	port id of this physical interface. This port id is used in LLDP to identify a physical port on the peering device	string
physical_interface_flow_control optional	User can enable this option to configure flow control on the physical interface.	boolean
physical_interface_lacp_force_up optional	User can enable this option to make LACP up and running. This is applicable only on individual member physical interfaces of a VPG.	boolean
physical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PhysicalInterfaceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ethernet_segment_identifier optional	Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should configure the peer Physical interface with the same ESI.	string
physical_interface_type optional	Physical interface type that can be either regular/LAG/service/fabric/access link.	Any of [‘regular’, ‘lag’, ‘service’, ‘fabric’, ‘access’]
physical_interface_mac_addresses optional	MAC addresses on this physical interface.	MacAddressesType
physical_interface_port_id optional	port id of this physical interface. This port id is used in LLDP to identify a physical port on the peering device	string
physical_interface_flow_control optional	User can enable this option to configure flow control on the physical interface.	boolean
physical_interface_lacp_force_up optional	User can enable this option to make LACP up and running. This is applicable only on individual member physical interfaces of a VPG.	boolean
physical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
service_appliance_back_refs optional	List of service-appliance back references	ServiceAppliancePhysicalInterfaceRefs array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
physical_interface_back_refs optional	List of physical-interface references	ResourceReference array
link_aggregation_group_back_refs optional	List of link-aggregation-group references	ResourceReference array
virtual_port_group_back_refs optional	List of virtual-port-group back references	VirtualPortGroupPhysicalInterfaceRefs array

PhysicalInterfaceUpdate

Name	Description	Schema
ethernet_segment_identifier optional	Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should configure the peer Physical interface with the same ESI.	string
physical_interface_type optional	Physical interface type that can be either regular/LAG/service/fabric/access link.	Any of [‘regular’, ‘lag’, ‘service’, ‘fabric’, ‘access’]
physical_interface_mac_addresses optional	MAC addresses on this physical interface.	MacAddressesType
physical_interface_port_id optional	port id of this physical interface. This port id is used in LLDP to identify a physical port on the peering device	string
physical_interface_flow_control optional	User can enable this option to configure flow control on the physical interface.	boolean
physical_interface_lacp_force_up optional	User can enable this option to make LACP up and running. This is applicable only on individual member physical interfaces of a VPG.	boolean
physical_interface_port_params optional	User can select this option to configure port parameters such as description, MTU and port enable or disable.	PortParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ResourceReference array
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PhysicalRoleCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PhysicalRoleReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PhysicalRoleReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
device_functional_group_back_refs optional	List of device-functional-group references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
role_definition_back_refs optional	List of role-definition references	ResourceReference array

PhysicalRoleUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PhysicalRouterCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
physical_router_junos_service_ports optional	Juniper JUNOS specific service interfaces name to perform services like NAT.	JunosServicePorts
telemetry_info optional	Telemetry info of router. Check TelemetryStateInfo	TelemetryStateInfo
physical_router_device_family required	Device family that this physical router is part of. It is used by the device manager to choose the device family specific Ansible playbooks for device management	string
physical_router_os_version optional	os version for this physical router. It is updated when device is imported or device image is successfully upgraded	string
physical_router_hostname optional	Device host name that can be either discovered during via fabric on-boarding workflow or manually set by the user	string
physical_router_management_ip required	Management ip for this physical router. It is used by the device manager to perform netconf and by SNMP collector if enabled.	string
physical_router_management_mac optional	Management mac for this physical router.	string
physical_router_dataplane_ip optional	This is ip address in the ip-fabric(underlay) network that can be used in data plane by physical router. Usually it is the VTEP address in VxLAN for the TOR switch.	string
physical_router_loopback_ip optional	This is ip address of loopback interface of physical router. Used by the device manager to configure physical router loopback interface.	string
physical_router_replicator_loopback_ip optional	This is the loopback ip address for assisted replication. Used by the device manager to configure physical router replicator ip.	string
physical_router_vendor_name required	Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_product_name required	Model name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_serial_number optional	Serial number for the physical device that is used by device manager to identify the device during device discovery.	string
physical_router_vnc_managed optional	This physical router is enabled to be configured by device manager.	boolean
physical_router_underlay_managed optional	Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this attribute to true. The brownfield on-boarding sets this attribute to false.	boolean
physical_router_role optional	Physical router role (e.g spine or leaf), used by the device manager to provision physical router, for e.g device manager may choose to configure physical router based on its role.	Any of [‘spine’, ‘leaf’, ‘e2-access’, ‘e2-provider’, ‘e2-internet’, ‘e2-vrr’, ‘pnf’, ‘superspine’]
routing_bridging_roles optional	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.	RoutingBridgingRolesType
physical_router_snmp optional	SNMP support on this router	boolean
physical_router_lldp optional	LLDP support on this router	boolean
physical_router_user_credentials optional	Username and password for netconf to the physical router by device manager.	UserCredentials
physical_router_encryption_type optional	Type of encryption used for physical-router-user-credentials.	Any of [‘none’, ‘local’]
physical_router_snmp_credentials optional	SNMP credentials for the physical router used by SNMP collector.	SNMPCredentials
physical_router_dhcp_parameters optional	Dnsmasq lease parameters for the physical router.	DnsmasqLeaseParameters
physical_router_cli_commit_state optional	CLI commit state for the physical router. Used to check if device is in sync with Contrail managed configs	Any of [‘in_sync’, ‘out_of_sync’]
physical_router_managed_state optional	Managed state for the physical router. Used to RMA devices	Any of [‘dhcp’, ‘rma’, ‘activating’, ‘active’, ‘maintenance’, ‘error’]
physical_router_onboarding_state optional	Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the device such as discovered, interface onboarded, topology discovered, underlay configured and others	Any of [‘discovered’, ‘interfaces_onboarded’, ‘topology_discovered’, ‘role_discovered’, ‘underlay_configured’]
physical_router_underlay_config optional	Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical- router-underlay-managed is false	string
physical_router_supplemental_config optional	Supplemental configuration stored during ZTP onboarding.	string
physical_router_autonomous_system optional	Autonomous system configured on the device represented by the physical router.	AutonomousSystemsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
node_profile_refs optional	List of node-profile references	ResourceReference array
device_functional_group_refs optional	List of device-functional-group references	ResourceReference array
device_chassis_refs optional	List of device-chassis references	ResourceReference array
device_image_refs optional	List of device-image references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
telemetry_profile_refs optional	List of telemetry-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PhysicalRouterReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
physical_router_junos_service_ports optional	Juniper JUNOS specific service interfaces name to perform services like NAT.	JunosServicePorts
telemetry_info optional	Telemetry info of router. Check TelemetryStateInfo	TelemetryStateInfo
physical_router_device_family optional	Device family that this physical router is part of. It is used by the device manager to choose the device family specific Ansible playbooks for device management	string
physical_router_os_version optional	os version for this physical router. It is updated when device is imported or device image is successfully upgraded	string
physical_router_hostname optional	Device host name that can be either discovered during via fabric on-boarding workflow or manually set by the user	string
physical_router_management_ip optional	Management ip for this physical router. It is used by the device manager to perform netconf and by SNMP collector if enabled.	string
physical_router_management_mac optional	Management mac for this physical router.	string
physical_router_dataplane_ip optional	This is ip address in the ip-fabric(underlay) network that can be used in data plane by physical router. Usually it is the VTEP address in VxLAN for the TOR switch.	string
physical_router_loopback_ip optional	This is ip address of loopback interface of physical router. Used by the device manager to configure physical router loopback interface.	string
physical_router_replicator_loopback_ip optional	This is the loopback ip address for assisted replication. Used by the device manager to configure physical router replicator ip.	string
physical_router_vendor_name optional	Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_product_name optional	Model name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_serial_number optional	Serial number for the physical device that is used by device manager to identify the device during device discovery.	string
physical_router_vnc_managed optional	This physical router is enabled to be configured by device manager.	boolean
physical_router_underlay_managed optional	Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this attribute to true. The brownfield on-boarding sets this attribute to false.	boolean
physical_router_role optional	Physical router role (e.g spine or leaf), used by the device manager to provision physical router, for e.g device manager may choose to configure physical router based on its role.	Any of [‘spine’, ‘leaf’, ‘e2-access’, ‘e2-provider’, ‘e2-internet’, ‘e2-vrr’, ‘pnf’, ‘superspine’]
routing_bridging_roles optional	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.	RoutingBridgingRolesType
physical_router_snmp optional	SNMP support on this router	boolean
physical_router_lldp optional	LLDP support on this router	boolean
physical_router_user_credentials optional	Username and password for netconf to the physical router by device manager.	UserCredentials
physical_router_encryption_type optional	Type of encryption used for physical-router-user-credentials.	Any of [‘none’, ‘local’]
physical_router_snmp_credentials optional	SNMP credentials for the physical router used by SNMP collector.	SNMPCredentials
physical_router_dhcp_parameters optional	Dnsmasq lease parameters for the physical router.	DnsmasqLeaseParameters
physical_router_cli_commit_state optional	CLI commit state for the physical router. Used to check if device is in sync with Contrail managed configs	Any of [‘in_sync’, ‘out_of_sync’]
physical_router_managed_state optional	Managed state for the physical router. Used to RMA devices	Any of [‘dhcp’, ‘rma’, ‘activating’, ‘active’, ‘maintenance’, ‘error’]
physical_router_onboarding_state optional	Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the device such as discovered, interface onboarded, topology discovered, underlay configured and others	Any of [‘discovered’, ‘interfaces_onboarded’, ‘topology_discovered’, ‘role_discovered’, ‘underlay_configured’]
physical_router_underlay_config optional	Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical- router-underlay-managed is false	string
physical_router_supplemental_config optional	Supplemental configuration stored during ZTP onboarding.	string
physical_router_autonomous_system optional	Autonomous system configured on the device represented by the physical router.	AutonomousSystemsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
node_profile_refs optional	List of node-profile references	ResourceReference array
device_functional_group_refs optional	List of device-functional-group references	ResourceReference array
device_chassis_refs optional	List of device-chassis references	ResourceReference array
device_image_refs optional	List of device-image references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
telemetry_profile_refs optional	List of telemetry-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PhysicalRouterReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
physical_router_junos_service_ports optional	Juniper JUNOS specific service interfaces name to perform services like NAT.	JunosServicePorts
telemetry_info optional	Telemetry info of router. Check TelemetryStateInfo	TelemetryStateInfo
physical_router_device_family optional	Device family that this physical router is part of. It is used by the device manager to choose the device family specific Ansible playbooks for device management	string
physical_router_os_version optional	os version for this physical router. It is updated when device is imported or device image is successfully upgraded	string
physical_router_hostname optional	Device host name that can be either discovered during via fabric on-boarding workflow or manually set by the user	string
physical_router_management_ip optional	Management ip for this physical router. It is used by the device manager to perform netconf and by SNMP collector if enabled.	string
physical_router_management_mac optional	Management mac for this physical router.	string
physical_router_dataplane_ip optional	This is ip address in the ip-fabric(underlay) network that can be used in data plane by physical router. Usually it is the VTEP address in VxLAN for the TOR switch.	string
physical_router_loopback_ip optional	This is ip address of loopback interface of physical router. Used by the device manager to configure physical router loopback interface.	string
physical_router_replicator_loopback_ip optional	This is the loopback ip address for assisted replication. Used by the device manager to configure physical router replicator ip.	string
physical_router_vendor_name optional	Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_product_name optional	Model name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_serial_number optional	Serial number for the physical device that is used by device manager to identify the device during device discovery.	string
physical_router_vnc_managed optional	This physical router is enabled to be configured by device manager.	boolean
physical_router_underlay_managed optional	Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this attribute to true. The brownfield on-boarding sets this attribute to false.	boolean
physical_router_role optional	Physical router role (e.g spine or leaf), used by the device manager to provision physical router, for e.g device manager may choose to configure physical router based on its role.	Any of [‘spine’, ‘leaf’, ‘e2-access’, ‘e2-provider’, ‘e2-internet’, ‘e2-vrr’, ‘pnf’, ‘superspine’]
routing_bridging_roles optional	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.	RoutingBridgingRolesType
physical_router_snmp optional	SNMP support on this router	boolean
physical_router_lldp optional	LLDP support on this router	boolean
physical_router_user_credentials optional	Username and password for netconf to the physical router by device manager.	UserCredentials
physical_router_encryption_type optional	Type of encryption used for physical-router-user-credentials.	Any of [‘none’, ‘local’]
physical_router_snmp_credentials optional	SNMP credentials for the physical router used by SNMP collector.	SNMPCredentials
physical_router_dhcp_parameters optional	Dnsmasq lease parameters for the physical router.	DnsmasqLeaseParameters
physical_router_cli_commit_state optional	CLI commit state for the physical router. Used to check if device is in sync with Contrail managed configs	Any of [‘in_sync’, ‘out_of_sync’]
physical_router_managed_state optional	Managed state for the physical router. Used to RMA devices	Any of [‘dhcp’, ‘rma’, ‘activating’, ‘active’, ‘maintenance’, ‘error’]
physical_router_onboarding_state optional	Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the device such as discovered, interface onboarded, topology discovered, underlay configured and others	Any of [‘discovered’, ‘interfaces_onboarded’, ‘topology_discovered’, ‘role_discovered’, ‘underlay_configured’]
physical_router_underlay_config optional	Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical- router-underlay-managed is false	string
physical_router_supplemental_config optional	Supplemental configuration stored during ZTP onboarding.	string
physical_router_autonomous_system optional	Autonomous system configured on the device represented by the physical router.	AutonomousSystemsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
node_profile_refs optional	List of node-profile references	ResourceReference array
device_functional_group_refs optional	List of device-functional-group references	ResourceReference array
device_chassis_refs optional	List of device-chassis references	ResourceReference array
device_image_refs optional	List of device-image references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
telemetry_profile_refs optional	List of telemetry-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array
service_endpoint_back_refs optional	List of service-endpoint references	ResourceReference array
network_device_config_back_refs optional	List of network-device-config references	ResourceReference array
e2_service_provider_back_refs optional	List of e2-service-provider references	ResourceReference array

PhysicalRouterUpdate

Name	Description	Schema
physical_router_junos_service_ports optional	Juniper JUNOS specific service interfaces name to perform services like NAT.	JunosServicePorts
telemetry_info optional	Telemetry info of router. Check TelemetryStateInfo	TelemetryStateInfo
physical_router_device_family optional	Device family that this physical router is part of. It is used by the device manager to choose the device family specific Ansible playbooks for device management	string
physical_router_os_version optional	os version for this physical router. It is updated when device is imported or device image is successfully upgraded	string
physical_router_hostname optional	Device host name that can be either discovered during via fabric on-boarding workflow or manually set by the user	string
physical_router_management_ip optional	Management ip for this physical router. It is used by the device manager to perform netconf and by SNMP collector if enabled.	string
physical_router_management_mac optional	Management mac for this physical router.	string
physical_router_dataplane_ip optional	This is ip address in the ip-fabric(underlay) network that can be used in data plane by physical router. Usually it is the VTEP address in VxLAN for the TOR switch.	string
physical_router_loopback_ip optional	This is ip address of loopback interface of physical router. Used by the device manager to configure physical router loopback interface.	string
physical_router_replicator_loopback_ip optional	This is the loopback ip address for assisted replication. Used by the device manager to configure physical router replicator ip.	string
physical_router_vendor_name optional	Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_product_name optional	Model name of the physical router (e.g juniper). Used by the device manager to select driver.	string
physical_router_serial_number optional	Serial number for the physical device that is used by device manager to identify the device during device discovery.	string
physical_router_vnc_managed optional	This physical router is enabled to be configured by device manager.	boolean
physical_router_underlay_managed optional	Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this attribute to true. The brownfield on-boarding sets this attribute to false.	boolean
physical_router_role optional	Physical router role (e.g spine or leaf), used by the device manager to provision physical router, for e.g device manager may choose to configure physical router based on its role.	Any of [‘spine’, ‘leaf’, ‘e2-access’, ‘e2-provider’, ‘e2-internet’, ‘e2-vrr’, ‘pnf’, ‘superspine’]
routing_bridging_roles optional	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.	RoutingBridgingRolesType
physical_router_snmp optional	SNMP support on this router	boolean
physical_router_lldp optional	LLDP support on this router	boolean
physical_router_user_credentials optional	Username and password for netconf to the physical router by device manager.	UserCredentials
physical_router_encryption_type optional	Type of encryption used for physical-router-user-credentials.	Any of [‘none’, ‘local’]
physical_router_snmp_credentials optional	SNMP credentials for the physical router used by SNMP collector.	SNMPCredentials
physical_router_dhcp_parameters optional	Dnsmasq lease parameters for the physical router.	DnsmasqLeaseParameters
physical_router_cli_commit_state optional	CLI commit state for the physical router. Used to check if device is in sync with Contrail managed configs	Any of [‘in_sync’, ‘out_of_sync’]
physical_router_managed_state optional	Managed state for the physical router. Used to RMA devices	Any of [‘dhcp’, ‘rma’, ‘activating’, ‘active’, ‘maintenance’, ‘error’]
physical_router_onboarding_state optional	Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the device such as discovered, interface onboarded, topology discovered, underlay configured and others	Any of [‘discovered’, ‘interfaces_onboarded’, ‘topology_discovered’, ‘role_discovered’, ‘underlay_configured’]
physical_router_underlay_config optional	Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical- router-underlay-managed is false	string
physical_router_supplemental_config optional	Supplemental configuration stored during ZTP onboarding.	string
physical_router_autonomous_system optional	Autonomous system configured on the device represented by the physical router.	AutonomousSystemsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
fabric_refs optional	List of fabric references	ResourceReference array
node_profile_refs optional	List of node-profile references	ResourceReference array
device_functional_group_refs optional	List of device-functional-group references	ResourceReference array
device_chassis_refs optional	List of device-chassis references	ResourceReference array
device_image_refs optional	List of device-image references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
telemetry_profile_refs optional	List of telemetry-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PolicyManagementCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PolicyManagementReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PolicyManagementReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PolicyManagementUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PortCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘node’]
port_group_uuid optional	UUID of the port group in which this port belongs	string
bms_port_info optional	Details of the baremetal server port	BaremetalPortInfo
esxi_port_info optional	Information related to Port-ESXi/vCenter	ESXIProperties
label optional	Label of the interface representing the use of the interface.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PortReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
port_group_uuid optional	UUID of the port group in which this port belongs	string
bms_port_info optional	Details of the baremetal server port	BaremetalPortInfo
esxi_port_info optional	Information related to Port-ESXi/vCenter	ESXIProperties
label optional	Label of the interface representing the use of the interface.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PortReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
port_group_uuid optional	UUID of the port group in which this port belongs	string
bms_port_info optional	Details of the baremetal server port	BaremetalPortInfo
esxi_port_info optional	Information related to Port-ESXi/vCenter	ESXIProperties
label optional	Label of the interface representing the use of the interface.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
port_group_back_refs optional	List of port-group references	ResourceReference array
physical_interface_back_refs optional	List of physical-interface references	ResourceReference array

PortUpdate

Name	Description	Schema
port_group_uuid optional	UUID of the port group in which this port belongs	string
bms_port_info optional	Details of the baremetal server port	BaremetalPortInfo
esxi_port_info optional	Information related to Port-ESXi/vCenter	ESXIProperties
label optional	Label of the interface representing the use of the interface.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

PortGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘node’]
bms_port_group_info optional	Details of the baremetal server port group	BaremetalPortGroupInfo
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
bms_port_group_info optional	Details of the baremetal server port group	BaremetalPortGroupInfo
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
bms_port_group_info optional	Details of the baremetal server port group	BaremetalPortGroupInfo
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortGroupUpdate

Name	Description	Schema
bms_port_group_info optional	Details of the baremetal server port group	BaremetalPortGroupInfo
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
port_refs optional	List of port references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
port_profile_params optional	This is to configure port attributes.	PortProfileParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
storm_control_profile_refs optional	List of storm-control-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
port_profile_params optional	This is to configure port attributes.	PortProfileParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
storm_control_profile_refs optional	List of storm-control-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
port_profile_params optional	This is to configure port attributes.	PortProfileParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
storm_control_profile_refs optional	List of storm-control-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_port_group_back_refs optional	List of virtual-port-group references	ResourceReference array

PortProfileUpdate

Name	Description	Schema
port_profile_params optional	This is to configure port attributes.	PortProfileParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
storm_control_profile_refs optional	List of storm-control-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortTupleCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘service-instance’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortTupleReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

PortTupleReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array

PortTupleUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
logical_router_refs optional	List of logical-router references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProjectCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘domain’]
mtu optional	MTU attribute for the virtual network	number
quota required	Max instances limits for various objects under project.	QuotaType
vxlan_routing optional	When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical router in the project.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
enable_security_policy_draft optional		boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
namespace_refs optional	List of namespace references	ProjectNamespaceRefs array
floating_ip_pool_refs optional	List of floating-ip-pool references	ResourceReference array
alias_ip_pool_refs optional	List of alias-ip-pool references	ResourceReference array
application_policy_set_refs optional	List of application-policy-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProjectReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
mtu optional	MTU attribute for the virtual network	number
quota optional	Max instances limits for various objects under project.	QuotaType
vxlan_routing optional	When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical router in the project.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
enable_security_policy_draft optional		boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
namespace_refs optional	List of namespace references	ProjectNamespaceRefs array
floating_ip_pool_refs optional	List of floating-ip-pool references	ResourceReference array
alias_ip_pool_refs optional	List of alias-ip-pool references	ResourceReference array
application_policy_set_refs optional	List of application-policy-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProjectReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
mtu optional	MTU attribute for the virtual network	number
quota optional	Max instances limits for various objects under project.	QuotaType
vxlan_routing optional	When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical router in the project.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
enable_security_policy_draft optional		boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
namespace_refs optional	List of namespace references	ProjectNamespaceRefs array
floating_ip_pool_refs optional	List of floating-ip-pool references	ResourceReference array
alias_ip_pool_refs optional	List of alias-ip-pool references	ResourceReference array
application_policy_set_refs optional	List of application-policy-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
floating_ip_back_refs optional	List of floating-ip references	ResourceReference array
alias_ip_back_refs optional	List of alias-ip references	ResourceReference array

ProjectUpdate

Name	Description	Schema
mtu optional	MTU attribute for the virtual network	number
quota optional	Max instances limits for various objects under project.	QuotaType
vxlan_routing optional	When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical router in the project.	boolean
alarm_enable optional	Flag to enable/disable alarms configured under global-system-config. True, if not set.	boolean
enable_security_policy_draft optional		boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
namespace_refs optional	List of namespace references	ProjectNamespaceRefs array
floating_ip_pool_refs optional	List of floating-ip-pool references	ResourceReference array
alias_ip_pool_refs optional	List of alias-ip-pool references	ResourceReference array
application_policy_set_refs optional	List of application-policy-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProviderAttachmentCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProviderAttachmentReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProviderAttachmentReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ProviderAttachmentUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_router_refs optional	List of virtual-router references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

QosConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-qos-config’, ‘project’]
qos_config_type required	Specifies if qos-config is for vhost, fabric or for project.	Any of [‘vhost’, ‘fabric’, ‘project’]
dscp_entries optional	Map of DSCP match condition and applicable forwarding class for packet.	QosIdForwardingClassPairs
vlan_priority_entries optional	Map of .1p priority code to applicable forwarding class for packet.	QosIdForwardingClassPairs
mpls_exp_entries optional	Map of MPLS EXP values to applicable forwarding class for packet.	QosIdForwardingClassPairs
default_forwarding_class_id required	Default forwarding class used for all non-specified QOS bits	number
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
global_system_config_refs optional	List of global-system-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

QosConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
qos_config_type optional	Specifies if qos-config is for vhost, fabric or for project.	Any of [‘vhost’, ‘fabric’, ‘project’]
dscp_entries optional	Map of DSCP match condition and applicable forwarding class for packet.	QosIdForwardingClassPairs
vlan_priority_entries optional	Map of .1p priority code to applicable forwarding class for packet.	QosIdForwardingClassPairs
mpls_exp_entries optional	Map of MPLS EXP values to applicable forwarding class for packet.	QosIdForwardingClassPairs
default_forwarding_class_id optional	Default forwarding class used for all non-specified QOS bits	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
global_system_config_refs optional	List of global-system-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

QosConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
qos_config_type optional	Specifies if qos-config is for vhost, fabric or for project.	Any of [‘vhost’, ‘fabric’, ‘project’]
dscp_entries optional	Map of DSCP match condition and applicable forwarding class for packet.	QosIdForwardingClassPairs
vlan_priority_entries optional	Map of .1p priority code to applicable forwarding class for packet.	QosIdForwardingClassPairs
mpls_exp_entries optional	Map of MPLS EXP values to applicable forwarding class for packet.	QosIdForwardingClassPairs
default_forwarding_class_id optional	Default forwarding class used for all non-specified QOS bits	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
global_system_config_refs optional	List of global-system-config references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array

QosConfigUpdate

Name	Description	Schema
qos_config_type optional	Specifies if qos-config is for vhost, fabric or for project.	Any of [‘vhost’, ‘fabric’, ‘project’]
dscp_entries optional	Map of DSCP match condition and applicable forwarding class for packet.	QosIdForwardingClassPairs
vlan_priority_entries optional	Map of .1p priority code to applicable forwarding class for packet.	QosIdForwardingClassPairs
mpls_exp_entries optional	Map of MPLS EXP values to applicable forwarding class for packet.	QosIdForwardingClassPairs
default_forwarding_class_id optional	Default forwarding class used for all non-specified QOS bits	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

QosQueueCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-qos-config’]
min_bandwidth required	Minimum bandwidth for this queue.	number
max_bandwidth required	Maximum bandwidth for this queue.	number
qos_queue_identifier required	Unique id for this queue.	number
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

QosQueueReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
min_bandwidth optional	Minimum bandwidth for this queue.	number
max_bandwidth optional	Maximum bandwidth for this queue.	number
qos_queue_identifier optional	Unique id for this queue.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

QosQueueReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
min_bandwidth optional	Minimum bandwidth for this queue.	number
max_bandwidth optional	Maximum bandwidth for this queue.	number
qos_queue_identifier optional	Unique id for this queue.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
forwarding_class_back_refs optional	List of forwarding-class references	ResourceReference array

QosQueueUpdate

Name	Description	Schema
min_bandwidth optional	Minimum bandwidth for this queue.	number
max_bandwidth optional	Maximum bandwidth for this queue.	number
qos_queue_identifier optional	Unique id for this queue.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RoleConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘node-profile’]
role_config_config required	role config in JSON format. This JSON config must conform to the input-schema of the job template for the role provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RoleConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
role_config_config optional	role config in JSON format. This JSON config must conform to the input-schema of the job template for the role provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RoleConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
role_config_config optional	role config in JSON format. This JSON config must conform to the input-schema of the job template for the role provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RoleConfigUpdate

Name	Description	Schema
role_config_config optional	role config in JSON format. This JSON config must conform to the input-schema of the job template for the role provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RoleDefinitionCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RoleDefinitionReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RoleDefinitionReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
node_profile_back_refs optional	List of node-profile references	ResourceReference array

RoleDefinitionUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
feature_refs optional	List of feature references	ResourceReference array
physical_role_refs optional	List of physical-role references	ResourceReference array
overlay_role_refs optional	List of overlay-role references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RouteAggregateCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
aggregate_route_entries required	List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This aggregate route is advertised if a matching(longest prefix match) prefix is found.	RouteListType
aggregate_route_nexthop required	Next for aggregate route that will be advertised.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	RouteAggregateServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RouteAggregateReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
aggregate_route_entries optional	List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This aggregate route is advertised if a matching(longest prefix match) prefix is found.	RouteListType
aggregate_route_nexthop optional	Next for aggregate route that will be advertised.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	RouteAggregateServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RouteAggregateReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
aggregate_route_entries optional	List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This aggregate route is advertised if a matching(longest prefix match) prefix is found.	RouteListType
aggregate_route_nexthop optional	Next for aggregate route that will be advertised.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	RouteAggregateServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RouteAggregateUpdate

Name	Description	Schema
aggregate_route_entries optional	List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This aggregate route is advertised if a matching(longest prefix match) prefix is found.	RouteListType
aggregate_route_nexthop optional	Next for aggregate route that will be advertised.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	RouteAggregateServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

RouteTableCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
routes required	Routes in the route table are configured in following way.	RouteTableType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RouteTableReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
routes optional	Routes in the route table are configured in following way.	RouteTableType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RouteTableReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
routes optional	Routes in the route table are configured in following way.	RouteTableType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array

RouteTableUpdate

Name	Description	Schema
routes optional	Routes in the route table are configured in following way.	RouteTableType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RouteTargetCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RouteTargetReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RouteTargetReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array
routing_instance_back_refs optional	List of routing-instance back references	RoutingInstanceRouteTargetRefs array

RouteTargetUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

RoutingInstanceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-network’]
service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
routing_instance_is_default optional	Internal service chaining information, should not be modified.	boolean
routing_instance_has_pnf optional	Internal service chaining information, should not be modified.	boolean
routing_instance_id optional	System assigned unique ID for every routing instance.	number
static_route_entries optional	Internal service chaining information, should not be modified.	StaticRouteEntriesType
routing_instance_fabric_snat optional	Provide connectivity to underlay network by port mapping trafficwith source IP of compute node	boolean
default_ce_protocol optional		DefaultProtocolType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
routing_instance_refs optional	List of routing-instance references	RoutingInstanceRoutingInstanceRefs array
route_target_refs optional	List of route-target references	RoutingInstanceRouteTargetRefs array
tag_refs optional	List of tag references	ResourceReference array

RoutingInstanceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
routing_instance_is_default optional	Internal service chaining information, should not be modified.	boolean
routing_instance_has_pnf optional	Internal service chaining information, should not be modified.	boolean
routing_instance_id optional	System assigned unique ID for every routing instance.	number
static_route_entries optional	Internal service chaining information, should not be modified.	StaticRouteEntriesType
routing_instance_fabric_snat optional	Provide connectivity to underlay network by port mapping trafficwith source IP of compute node	boolean
default_ce_protocol optional		DefaultProtocolType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
routing_instance_refs optional	List of routing-instance references	RoutingInstanceRoutingInstanceRefs array
route_target_refs optional	List of route-target references	RoutingInstanceRouteTargetRefs array
tag_refs optional	List of tag references	ResourceReference array

RoutingInstanceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
routing_instance_is_default optional	Internal service chaining information, should not be modified.	boolean
routing_instance_has_pnf optional	Internal service chaining information, should not be modified.	boolean
routing_instance_id optional	System assigned unique ID for every routing instance.	number
static_route_entries optional	Internal service chaining information, should not be modified.	StaticRouteEntriesType
routing_instance_fabric_snat optional	Provide connectivity to underlay network by port mapping trafficwith source IP of compute node	boolean
default_ce_protocol optional		DefaultProtocolType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
routing_instance_refs optional	List of routing-instance references	RoutingInstanceRoutingInstanceRefs array
route_target_refs optional	List of route-target references	RoutingInstanceRouteTargetRefs array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface back references	VirtualMachineInterfaceRoutingInstanceRefs array
route_aggregate_back_refs optional	List of route-aggregate references	ResourceReference array
routing_policy_back_refs optional	List of routing-policy back references	RoutingPolicyRoutingInstanceRefs array
routing_instance_back_refs optional	List of routing-instance back references	RoutingInstanceRoutingInstanceRefs array

RoutingInstanceUpdate

Name	Description	Schema
service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
evpn_ipv6_service_chain_information optional	Internal service chaining information, should not be modified.	ServiceChainInfo
routing_instance_is_default optional	Internal service chaining information, should not be modified.	boolean
routing_instance_has_pnf optional	Internal service chaining information, should not be modified.	boolean
static_route_entries optional	Internal service chaining information, should not be modified.	StaticRouteEntriesType
routing_instance_fabric_snat optional	Provide connectivity to underlay network by port mapping trafficwith source IP of compute node	boolean
default_ce_protocol optional		DefaultProtocolType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
routing_instance_refs optional	List of routing-instance references	RoutingInstanceRoutingInstanceRefs array
route_target_refs optional	List of route-target references	RoutingInstanceRouteTargetRefs array
tag_refs optional	List of tag references	ResourceReference array

RoutingPolicyCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
routing_policy_entries optional		PolicyStatementType
term_type optional		Any of [‘vrouter’, ‘network-device’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
service_instance_refs optional	List of service-instance references	RoutingPolicyServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	RoutingPolicyRoutingInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

RoutingPolicyReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
routing_policy_entries optional		PolicyStatementType
term_type optional		Any of [‘vrouter’, ‘network-device’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
service_instance_refs optional	List of service-instance references	RoutingPolicyServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	RoutingPolicyRoutingInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

RoutingPolicyReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
routing_policy_entries optional		PolicyStatementType
term_type optional		Any of [‘vrouter’, ‘network-device’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
service_instance_refs optional	List of service-instance references	RoutingPolicyServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	RoutingPolicyRoutingInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array
data_center_interconnect_back_refs optional	List of data-center-interconnect references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network back references	VirtualNetworkRoutingPolicyRefs array

RoutingPolicyUpdate

Name	Description	Schema
routing_policy_entries optional		PolicyStatementType
term_type optional		Any of [‘vrouter’, ‘network-device’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
service_instance_refs optional	List of service-instance references	RoutingPolicyServiceInstanceRefs array
routing_instance_refs optional	List of routing-instance references	RoutingPolicyRoutingInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

SecurityGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
configured_security_group_id optional	Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].	number
security_group_entries required	Security group rule entries.	PolicyEntriesType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SecurityGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
security_group_id optional	Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].	number
configured_security_group_id optional	Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].	number
security_group_entries optional	Security group rule entries.	PolicyEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SecurityGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
security_group_id optional	Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].	number
configured_security_group_id optional	Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].	number
security_group_entries optional	Security group rule entries.	PolicyEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
security_logging_object_back_refs optional	List of security-logging-object back references	SecurityLoggingObjectSecurityGroupRefs array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_port_group_back_refs optional	List of virtual-port-group references	ResourceReference array

SecurityGroupUpdate

Name	Description	Schema
configured_security_group_id optional	Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].	number
security_group_entries optional	Security group rule entries.	PolicyEntriesType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SecurityLoggingObjectCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-vrouter-config’, ‘project’]
security_logging_object_rules optional	Security logging object rules derived internally.	SecurityLoggingObjectRuleListType
security_logging_object_rate optional	Security logging object rate defining rate of session logging	number
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_policy_refs optional	List of network-policy references	SecurityLoggingObjectNetworkPolicyRefs array
security_group_refs optional	List of security-group references	SecurityLoggingObjectSecurityGroupRefs array
tag_refs optional	List of tag references	ResourceReference array

SecurityLoggingObjectReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
security_logging_object_rules optional	Security logging object rules derived internally.	SecurityLoggingObjectRuleListType
security_logging_object_rate optional	Security logging object rate defining rate of session logging	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_policy_refs optional	List of network-policy references	SecurityLoggingObjectNetworkPolicyRefs array
security_group_refs optional	List of security-group references	SecurityLoggingObjectSecurityGroupRefs array
tag_refs optional	List of tag references	ResourceReference array

SecurityLoggingObjectReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
security_logging_object_rules optional	Security logging object rules derived internally.	SecurityLoggingObjectRuleListType
security_logging_object_rate optional	Security logging object rate defining rate of session logging	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_policy_refs optional	List of network-policy references	SecurityLoggingObjectNetworkPolicyRefs array
security_group_refs optional	List of security-group references	SecurityLoggingObjectSecurityGroupRefs array
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
firewall_policy_back_refs optional	List of firewall-policy back references	FirewallPolicySecurityLoggingObjectRefs array
firewall_rule_back_refs optional	List of firewall-rule back references	FirewallRuleSecurityLoggingObjectRefs array

SecurityLoggingObjectUpdate

Name	Description	Schema
security_logging_object_rules optional	Security logging object rules derived internally.	SecurityLoggingObjectRuleListType
security_logging_object_rate optional	Security logging object rate defining rate of session logging	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_policy_refs optional	List of network-policy references	SecurityLoggingObjectNetworkPolicyRefs array
security_group_refs optional	List of security-group references	SecurityLoggingObjectSecurityGroupRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘service-appliance-set’]
service_appliance_user_credentials optional	Authentication credentials for driver to access service appliance.	UserCredentials
service_appliance_ip_address required	Management Ip address of the service-appliance.	string
service_appliance_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_properties required	List of Key:Value pairs used by the provider driver of this service appliance.	KeyValuePairs
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ServiceAppliancePhysicalInterfaceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_appliance_user_credentials optional	Authentication credentials for driver to access service appliance.	UserCredentials
service_appliance_ip_address optional	Management Ip address of the service-appliance.	string
service_appliance_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_properties optional	List of Key:Value pairs used by the provider driver of this service appliance.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ServiceAppliancePhysicalInterfaceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_appliance_user_credentials optional	Authentication credentials for driver to access service appliance.	UserCredentials
service_appliance_ip_address optional	Management Ip address of the service-appliance.	string
service_appliance_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_properties optional	List of Key:Value pairs used by the provider driver of this service appliance.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ServiceAppliancePhysicalInterfaceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceUpdate

Name	Description	Schema
service_appliance_user_credentials optional	Authentication credentials for driver to access service appliance.	UserCredentials
service_appliance_ip_address optional	Management Ip address of the service-appliance.	string
service_appliance_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_properties optional	List of Key:Value pairs used by the provider driver of this service appliance.	KeyValuePairs
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	ServiceAppliancePhysicalInterfaceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceSetCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
service_appliance_set_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_set_properties optional	List of Key:Value pairs that are used by the provider driver and opaque to system.	KeyValuePairs
service_appliance_driver optional	Name of the provider driver for this service appliance set.	string
service_appliance_ha_mode optional	High availability mode for the service appliance set, active-active or active-backup.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceSetReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_appliance_set_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_set_properties optional	List of Key:Value pairs that are used by the provider driver and opaque to system.	KeyValuePairs
service_appliance_driver optional	Name of the provider driver for this service appliance set.	string
service_appliance_ha_mode optional	High availability mode for the service appliance set, active-active or active-backup.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceApplianceSetReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_appliance_set_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_set_properties optional	List of Key:Value pairs that are used by the provider driver and opaque to system.	KeyValuePairs
service_appliance_driver optional	Name of the provider driver for this service appliance set.	string
service_appliance_ha_mode optional	High availability mode for the service appliance set, active-active or active-backup.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
service_template_back_refs optional	List of service-template references	ResourceReference array
loadbalancer_pool_back_refs optional	List of loadbalancer-pool references	ResourceReference array
loadbalancer_back_refs optional	List of loadbalancer references	ResourceReference array

ServiceApplianceSetUpdate

Name	Description	Schema
service_appliance_set_virtualization_type optional	Service virtualization type decides how individual service instances are instantiated	Any of [‘virtual-machine’, ‘network-namespace’, ‘vrouter-instance’, ‘physical-device’]
service_appliance_set_properties optional	List of Key:Value pairs that are used by the provider driver and opaque to system.	KeyValuePairs
service_appliance_driver optional	Name of the provider driver for this service appliance set.	string
service_appliance_ha_mode optional	High availability mode for the service appliance set, active-active or active-backup.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceConnectionModuleCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
e2_service required	E2 service type.	Any of [‘point-to-point’, ‘point-to-list’, ‘multi-point-to-multi-point’]
service_type required	Type of service assigned for this object	Any of [‘vpws-l2ckt’, ‘vpws-l2vpn’, ‘vpws-evpn’, ‘fabric-interface’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceConnectionModuleReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
e2_service optional	E2 service type.	Any of [‘point-to-point’, ‘point-to-list’, ‘multi-point-to-multi-point’]
service_type optional	Type of service assigned for this object	Any of [‘vpws-l2ckt’, ‘vpws-l2vpn’, ‘vpws-evpn’, ‘fabric-interface’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceConnectionModuleReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
e2_service optional	E2 service type.	Any of [‘point-to-point’, ‘point-to-list’, ‘multi-point-to-multi-point’]
service_type optional	Type of service assigned for this object	Any of [‘vpws-l2ckt’, ‘vpws-l2vpn’, ‘vpws-evpn’, ‘fabric-interface’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
service_endpoint_back_refs optional	List of service-endpoint references	ResourceReference array

ServiceConnectionModuleUpdate

Name	Description	Schema
e2_service optional	E2 service type.	Any of [‘point-to-point’, ‘point-to-list’, ‘multi-point-to-multi-point’]
service_type optional	Type of service assigned for this object	Any of [‘vpws-l2ckt’, ‘vpws-l2vpn’, ‘vpws-evpn’, ‘fabric-interface’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceEndpointCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_connection_module_refs optional	List of service-connection-module references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceEndpointReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_connection_module_refs optional	List of service-connection-module references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceEndpointReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_connection_module_refs optional	List of service-connection-module references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array

ServiceEndpointUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_connection_module_refs optional	List of service-connection-module references	ResourceReference array
physical_router_refs optional	List of physical-router references	ResourceReference array
service_object_refs optional	List of service-object references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘policy-management’, ‘project’]
service_group_firewall_service_list required	list of service objects (protocol, source port and destination port	FirewallServiceGroupType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
service_group_firewall_service_list optional	list of service objects (protocol, source port and destination port	FirewallServiceGroupType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
draft_mode_state optional		Any of [‘created’, ‘updated’, ‘deleted’]
service_group_firewall_service_list optional	list of service objects (protocol, source port and destination port	FirewallServiceGroupType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
firewall_rule_back_refs optional	List of firewall-rule references	ResourceReference array

ServiceGroupUpdate

Name	Description	Schema
service_group_firewall_service_list optional	list of service objects (protocol, source port and destination port	FirewallServiceGroupType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceHealthCheckCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
service_health_check_properties required	Service health check has following fields.	ServiceHealthCheckType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ServiceHealthCheckServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceHealthCheckReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_health_check_properties optional	Service health check has following fields.	ServiceHealthCheckType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ServiceHealthCheckServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceHealthCheckReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_health_check_properties optional	Service health check has following fields.	ServiceHealthCheckType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ServiceHealthCheckServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
bgp_as_a_service_back_refs optional	List of bgp-as-a-service references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array

ServiceHealthCheckUpdate

Name	Description	Schema
service_health_check_properties optional	Service health check has following fields.	ServiceHealthCheckType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ServiceHealthCheckServiceInstanceRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceInstanceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
service_instance_properties required	Service instance configuration parameters.	ServiceInstanceType
service_instance_bindings optional	Opaque key value pair for generating config for the service instance.	KeyValuePairs
service_instance_bgp_enabled optional	Enable BGP routing for this service instance	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_template_refs required	List of service-template references	ResourceReference array
instance_ip_refs optional	List of instance-ip references	ServiceInstanceInstanceIpRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceInstanceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_instance_properties optional	Service instance configuration parameters.	ServiceInstanceType
service_instance_bindings optional	Opaque key value pair for generating config for the service instance.	KeyValuePairs
service_instance_bgp_enabled optional	Enable BGP routing for this service instance	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_template_refs optional	List of service-template references	ResourceReference array
instance_ip_refs optional	List of instance-ip references	ServiceInstanceInstanceIpRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceInstanceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_instance_properties optional	Service instance configuration parameters.	ServiceInstanceType
service_instance_bindings optional	Opaque key value pair for generating config for the service instance.	KeyValuePairs
service_instance_bgp_enabled optional	Enable BGP routing for this service instance	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_template_refs optional	List of service-template references	ResourceReference array
instance_ip_refs optional	List of instance-ip references	ServiceInstanceInstanceIpRefs array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_back_refs optional	List of virtual-machine references	ResourceReference array
service_health_check_back_refs optional	List of service-health-check back references	ServiceHealthCheckServiceInstanceRefs array
interface_route_table_back_refs optional	List of interface-route-table back references	InterfaceRouteTableServiceInstanceRefs array
routing_policy_back_refs optional	List of routing-policy back references	RoutingPolicyServiceInstanceRefs array
route_aggregate_back_refs optional	List of route-aggregate back references	RouteAggregateServiceInstanceRefs array
logical_router_back_refs optional	List of logical-router references	ResourceReference array
loadbalancer_pool_back_refs optional	List of loadbalancer-pool references	ResourceReference array
loadbalancer_back_refs optional	List of loadbalancer references	ResourceReference array

ServiceInstanceUpdate

Name	Description	Schema
service_instance_properties optional	Service instance configuration parameters.	ServiceInstanceType
service_instance_bindings optional	Opaque key value pair for generating config for the service instance.	KeyValuePairs
service_instance_bgp_enabled optional	Enable BGP routing for this service instance	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_template_refs optional	List of service-template references	ResourceReference array
instance_ip_refs optional	List of instance-ip references	ServiceInstanceInstanceIpRefs array
tag_refs optional	List of tag references	ResourceReference array

ServiceObjectCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceObjectReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceObjectReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
service_endpoint_back_refs optional	List of service-endpoint references	ResourceReference array
service_connection_module_back_refs optional	List of service-connection-module references	ResourceReference array

ServiceObjectUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

ServiceTemplateCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘domain’]
service_template_properties required	Service template configuration parameters.	ServiceTemplateType
service_config_managed optional	Enable whether service config for PNFs needs to be managed by Contrail	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceTemplateReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_template_properties optional	Service template configuration parameters.	ServiceTemplateType
service_config_managed optional	Enable whether service config for PNFs needs to be managed by Contrail	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

ServiceTemplateReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
service_template_properties optional	Service template configuration parameters.	ServiceTemplateType
service_config_managed optional	Enable whether service config for PNFs needs to be managed by Contrail	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
service_instance_back_refs optional	List of service-instance references	ResourceReference array

ServiceTemplateUpdate

Name	Description	Schema
service_template_properties optional	Service template configuration parameters.	ServiceTemplateType
service_config_managed optional	Enable whether service config for PNFs needs to be managed by Contrail	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_appliance_set_refs optional	List of service-appliance-set references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

SflowProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
sflow_profile_is_default optional	This attribute indicates whether it is a default sflow profile or not. Default profiles are non- editable.	boolean
sflow_parameters optional	Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled interfaces, sflow agent ID etc.	SflowParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SflowProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
sflow_profile_is_default optional	This attribute indicates whether it is a default sflow profile or not. Default profiles are non- editable.	boolean
sflow_parameters optional	Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled interfaces, sflow agent ID etc.	SflowParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SflowProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
sflow_profile_is_default optional	This attribute indicates whether it is a default sflow profile or not. Default profiles are non- editable.	boolean
sflow_parameters optional	Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled interfaces, sflow agent ID etc.	SflowParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
telemetry_profile_back_refs optional	List of telemetry-profile references	ResourceReference array

SflowProfileUpdate

Name	Description	Schema
sflow_profile_is_default optional	This attribute indicates whether it is a default sflow profile or not. Default profiles are non- editable.	boolean
sflow_parameters optional	Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled interfaces, sflow agent ID etc.	SflowParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SnmpProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
snmp_profile_is_default optional	This attribute indicates whether it is a default snmp profile or not. Default profiles are non- editable.	boolean
snmp_parameters optional	Parameters for each snmp profile like the top level sensor options etc.	SnmpParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SnmpProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
snmp_profile_is_default optional	This attribute indicates whether it is a default snmp profile or not. Default profiles are non- editable.	boolean
snmp_parameters optional	Parameters for each snmp profile like the top level sensor options etc.	SnmpParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SnmpProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
snmp_profile_is_default optional	This attribute indicates whether it is a default snmp profile or not. Default profiles are non- editable.	boolean
snmp_parameters optional	Parameters for each snmp profile like the top level sensor options etc.	SnmpParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
telemetry_profile_back_refs optional	List of telemetry-profile references	ResourceReference array

SnmpProfileUpdate

Name	Description	Schema
snmp_profile_is_default optional	This attribute indicates whether it is a default snmp profile or not. Default profiles are non- editable.	boolean
snmp_parameters optional	Parameters for each snmp profile like the top level sensor options etc.	SnmpParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StormControlProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
storm_control_parameters optional	Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type, receovery timeout etc.	StormControlParameters
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StormControlProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
storm_control_parameters optional	Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type, receovery timeout etc.	StormControlParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StormControlProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
storm_control_parameters optional	Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type, receovery timeout etc.	StormControlParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
port_profile_back_refs optional	List of port-profile references	ResourceReference array

StormControlProfileUpdate

Name	Description	Schema
storm_control_parameters optional	Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type, receovery timeout etc.	StormControlParameters
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogApplicationRecordCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘structured-syslog-config’]
structured_syslog_app_category required	The application category	string
structured_syslog_app_subcategory optional	The application sub category	string
structured_syslog_app_groups optional	app groups comma separated	string
structured_syslog_app_risk optional	The application risk profile	string
structured_syslog_app_service_tags optional	service-tags corresponding to applications	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogApplicationRecordReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_app_category optional	The application category	string
structured_syslog_app_subcategory optional	The application sub category	string
structured_syslog_app_groups optional	app groups comma separated	string
structured_syslog_app_risk optional	The application risk profile	string
structured_syslog_app_service_tags optional	service-tags corresponding to applications	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogApplicationRecordReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_app_category optional	The application category	string
structured_syslog_app_subcategory optional	The application sub category	string
structured_syslog_app_groups optional	app groups comma separated	string
structured_syslog_app_risk optional	The application risk profile	string
structured_syslog_app_service_tags optional	service-tags corresponding to applications	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogApplicationRecordUpdate

Name	Description	Schema
structured_syslog_app_category optional	The application category	string
structured_syslog_app_subcategory optional	The application sub category	string
structured_syslog_app_groups optional	app groups comma separated	string
structured_syslog_app_risk optional	The application risk profile	string
structured_syslog_app_service_tags optional	service-tags corresponding to applications	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogConfigCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-analytics-config’, ‘project’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogConfigReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogConfigReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogConfigUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogHostnameRecordCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘structured-syslog-config’]
structured_syslog_hostaddr required	The host address	string
structured_syslog_tenant required	The tenant name	string
structured_syslog_location required	location details	string
structured_syslog_device optional	device id	string
structured_syslog_hostname_tags optional	tags corresponding to the host	string
structured_syslog_linkmap optional	overlay to underlay mapping	StructuredSyslogLinkmap
structured_syslog_lan_segment_list optional	vpn to network-ranges mapping	StructuredSyslogLANSegmentList
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogHostnameRecordReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_hostaddr optional	The host address	string
structured_syslog_tenant optional	The tenant name	string
structured_syslog_location optional	location details	string
structured_syslog_device optional	device id	string
structured_syslog_hostname_tags optional	tags corresponding to the host	string
structured_syslog_linkmap optional	overlay to underlay mapping	StructuredSyslogLinkmap
structured_syslog_lan_segment_list optional	vpn to network-ranges mapping	StructuredSyslogLANSegmentList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogHostnameRecordReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_hostaddr optional	The host address	string
structured_syslog_tenant optional	The tenant name	string
structured_syslog_location optional	location details	string
structured_syslog_device optional	device id	string
structured_syslog_hostname_tags optional	tags corresponding to the host	string
structured_syslog_linkmap optional	overlay to underlay mapping	StructuredSyslogLinkmap
structured_syslog_lan_segment_list optional	vpn to network-ranges mapping	StructuredSyslogLANSegmentList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogHostnameRecordUpdate

Name	Description	Schema
structured_syslog_hostaddr optional	The host address	string
structured_syslog_tenant optional	The tenant name	string
structured_syslog_location optional	location details	string
structured_syslog_device optional	device id	string
structured_syslog_hostname_tags optional	tags corresponding to the host	string
structured_syslog_linkmap optional	overlay to underlay mapping	StructuredSyslogLinkmap
structured_syslog_lan_segment_list optional	vpn to network-ranges mapping	StructuredSyslogLANSegmentList
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogMessageCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘structured-syslog-config’]
structured_syslog_message_tagged_fields required	list of field names in the message to be tagged	FieldNamesList
structured_syslog_message_integer_fields required	list of integer fields in the message	FieldNamesList
structured_syslog_message_process_and_store required	message is to be processed and stored or not	boolean
structured_syslog_message_process_and_summarize required	message is to be processed and summarized or not	boolean
structured_syslog_message_process_and_summarize_user required	message is to be processed and summarized for user or not	boolean
structured_syslog_message_forward required	fowarding action to be taken on the message	Any of [‘do-not-forward’, ‘forward-unprocessed’, ‘forward-processed’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogMessageReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_message_tagged_fields optional	list of field names in the message to be tagged	FieldNamesList
structured_syslog_message_integer_fields optional	list of integer fields in the message	FieldNamesList
structured_syslog_message_process_and_store optional	message is to be processed and stored or not	boolean
structured_syslog_message_process_and_summarize optional	message is to be processed and summarized or not	boolean
structured_syslog_message_process_and_summarize_user optional	message is to be processed and summarized for user or not	boolean
structured_syslog_message_forward optional	fowarding action to be taken on the message	Any of [‘do-not-forward’, ‘forward-unprocessed’, ‘forward-processed’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogMessageReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_message_tagged_fields optional	list of field names in the message to be tagged	FieldNamesList
structured_syslog_message_integer_fields optional	list of integer fields in the message	FieldNamesList
structured_syslog_message_process_and_store optional	message is to be processed and stored or not	boolean
structured_syslog_message_process_and_summarize optional	message is to be processed and summarized or not	boolean
structured_syslog_message_process_and_summarize_user optional	message is to be processed and summarized for user or not	boolean
structured_syslog_message_forward optional	fowarding action to be taken on the message	Any of [‘do-not-forward’, ‘forward-unprocessed’, ‘forward-processed’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogMessageUpdate

Name	Description	Schema
structured_syslog_message_tagged_fields optional	list of field names in the message to be tagged	FieldNamesList
structured_syslog_message_integer_fields optional	list of integer fields in the message	FieldNamesList
structured_syslog_message_process_and_store optional	message is to be processed and stored or not	boolean
structured_syslog_message_process_and_summarize optional	message is to be processed and summarized or not	boolean
structured_syslog_message_process_and_summarize_user optional	message is to be processed and summarized for user or not	boolean
structured_syslog_message_forward optional	fowarding action to be taken on the message	Any of [‘do-not-forward’, ‘forward-unprocessed’, ‘forward-processed’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogSlaProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘structured-syslog-config’]
structured_syslog_sla_params required	The sla params like sampling %age and traffic type	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogSlaProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_sla_params optional	The sla params like sampling %age and traffic type	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogSlaProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_sla_params optional	The sla params like sampling %age and traffic type	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogSlaProfileUpdate

Name	Description	Schema
structured_syslog_sla_params optional	The sla params like sampling %age and traffic type	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogTenantRecordCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘structured-syslog-config’]
structured_syslog_tenant required	The tenant name	string
structured_syslog_tenantaddr required	The tenant address	string
structured_syslog_tenant_tags optional	tags corresponding to the tenant	string
structured_syslog_dscpmap optional	dscp to Alias mapping	StructuredSyslogDSCPMap
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogTenantRecordReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_tenant optional	The tenant name	string
structured_syslog_tenantaddr optional	The tenant address	string
structured_syslog_tenant_tags optional	tags corresponding to the tenant	string
structured_syslog_dscpmap optional	dscp to Alias mapping	StructuredSyslogDSCPMap
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogTenantRecordReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
structured_syslog_tenant optional	The tenant name	string
structured_syslog_tenantaddr optional	The tenant address	string
structured_syslog_tenant_tags optional	tags corresponding to the tenant	string
structured_syslog_dscpmap optional	dscp to Alias mapping	StructuredSyslogDSCPMap
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

StructuredSyslogTenantRecordUpdate

Name	Description	Schema
structured_syslog_tenant optional	The tenant name	string
structured_syslog_tenantaddr optional	The tenant address	string
structured_syslog_tenant_tags optional	tags corresponding to the tenant	string
structured_syslog_dscpmap optional	dscp to Alias mapping	StructuredSyslogDSCPMap
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SubClusterCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
sub_cluster_asn required	AS number of that cluster.	number
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SubClusterReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
sub_cluster_asn optional	AS number of that cluster.	number
sub_cluster_id optional	Unique 16 or 32 bit ID assigned to this sub-cluster. User can define the ID he wants to use.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SubClusterReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
sub_cluster_asn optional	AS number of that cluster.	number
sub_cluster_id optional	Unique 16 or 32 bit ID assigned to this sub-cluster. User can define the ID he wants to use.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
virtual_router_back_refs optional	List of virtual-router references	ResourceReference array
bgp_router_back_refs optional	List of bgp-router references	ResourceReference array

SubClusterUpdate

Name	Description	Schema
sub_cluster_asn optional	AS number of that cluster.	number
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

SubnetCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
subnet_ip_prefix required	Ip prefix/length of the subnet.	SubnetType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

SubnetReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
subnet_ip_prefix optional	Ip prefix/length of the subnet.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

SubnetReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
subnet_ip_prefix optional	Ip prefix/length of the subnet.	SubnetType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

SubnetUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

TagCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
tag_type_name required	Tag type string representation	string
tag_value required	Tag value string representation	string
tag_predefined optional	Tag delete boolean representation	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_type_refs optional	List of tag-type references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

TagReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
tag_type_name optional	Tag type string representation	string
tag_value optional	Tag value string representation	string
tag_predefined optional	Tag delete boolean representation	boolean
tag_id optional	Internal Tag ID encapsulating tag type and value in hexadecimal fomat: 0xTTTTVVVV (T: type, V: value)	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_type_refs optional	List of tag-type references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

TagReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
tag_type_name optional	Tag type string representation	string
tag_value optional	Tag value string representation	string
tag_predefined optional	Tag delete boolean representation	boolean
tag_id optional	Internal Tag ID encapsulating tag type and value in hexadecimal fomat: 0xTTTTVVVV (T: type, V: value)	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_type_refs optional	List of tag-type references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
service_endpoint_back_refs optional	List of service-endpoint references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array
service_appliance_set_back_refs optional	List of service-appliance-set references	ResourceReference array
route_target_back_refs optional	List of route-target references	ResourceReference array
loadbalancer_listener_back_refs optional	List of loadbalancer-listener references	ResourceReference array
floating_ip_pool_back_refs optional	List of floating-ip-pool references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
config_root_back_refs optional	List of config-root references	ResourceReference array
service_template_back_refs optional	List of service-template references	ResourceReference array
hardware_inventory_back_refs optional	List of hardware-inventory references	ResourceReference array
firewall_policy_back_refs optional	List of firewall-policy references	ResourceReference array
route_table_back_refs optional	List of route-table references	ResourceReference array
provider_attachment_back_refs optional	List of provider-attachment references	ResourceReference array
overlay_role_back_refs optional	List of overlay-role references	ResourceReference array
multicast_policy_back_refs optional	List of multicast-policy references	ResourceReference array
network_device_config_back_refs optional	List of network-device-config references	ResourceReference array
virtual_DNS_record_back_refs optional	List of virtual-DNS-record references	ResourceReference array
control_node_zone_back_refs optional	List of control-node-zone references	ResourceReference array
dsa_rule_back_refs optional	List of dsa-rule references	ResourceReference array
structured_syslog_config_back_refs optional	List of structured-syslog-config references	ResourceReference array
discovery_service_assignment_back_refs optional	List of discovery-service-assignment references	ResourceReference array
logical_interface_back_refs optional	List of logical-interface references	ResourceReference array
flow_node_back_refs optional	List of flow-node references	ResourceReference array
port_group_back_refs optional	List of port-group references	ResourceReference array
route_aggregate_back_refs optional	List of route-aggregate references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array
domain_back_refs optional	List of domain references	ResourceReference array
structured_syslog_hostname_record_back_refs optional	List of structured-syslog-hostname-record references	ResourceReference array
service_instance_back_refs optional	List of service-instance references	ResourceReference array
node_profile_back_refs optional	List of node-profile references	ResourceReference array
bridge_domain_back_refs optional	List of bridge-domain references	ResourceReference array
alias_ip_back_refs optional	List of alias-ip references	ResourceReference array
webui_node_back_refs optional	List of webui-node references	ResourceReference array
port_back_refs optional	List of port references	ResourceReference array
bgp_as_a_service_back_refs optional	List of bgp-as-a-service references	ResourceReference array
subnet_back_refs optional	List of subnet references	ResourceReference array
global_system_config_back_refs optional	List of global-system-config references	ResourceReference array
sub_cluster_back_refs optional	List of sub-cluster references	ResourceReference array
forwarding_class_back_refs optional	List of forwarding-class references	ResourceReference array
service_group_back_refs optional	List of service-group references	ResourceReference array
global_analytics_config_back_refs optional	List of global-analytics-config references	ResourceReference array
address_group_back_refs optional	List of address-group references	ResourceReference array
application_policy_set_back_refs optional	List of application-policy-set references	ResourceReference array
virtual_ip_back_refs optional	List of virtual-ip references	ResourceReference array
intent_map_back_refs optional	List of intent-map references	ResourceReference array
port_tuple_back_refs optional	List of port-tuple references	ResourceReference array
analytics_alarm_node_back_refs optional	List of analytics-alarm-node references	ResourceReference array
netconf_profile_back_refs optional	List of netconf-profile references	ResourceReference array
qos_queue_back_refs optional	List of qos-queue references	ResourceReference array
physical_role_back_refs optional	List of physical-role references	ResourceReference array
card_back_refs optional	List of card references	ResourceReference array
security_logging_object_back_refs optional	List of security-logging-object references	ResourceReference array
qos_config_back_refs optional	List of qos-config references	ResourceReference array
analytics_snmp_node_back_refs optional	List of analytics-snmp-node references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
cli_config_back_refs optional	List of cli-config references	ResourceReference array
service_object_back_refs optional	List of service-object references	ResourceReference array
feature_flag_back_refs optional	List of feature-flag references	ResourceReference array
loadbalancer_back_refs optional	List of loadbalancer references	ResourceReference array
structured_syslog_tenant_record_back_refs optional	List of structured-syslog-tenant-record references	ResourceReference array
peering_policy_back_refs optional	List of peering-policy references	ResourceReference array
structured_syslog_application_record_back_refs optional	List of structured-syslog-application-record references	ResourceReference array
global_vrouter_config_back_refs optional	List of global-vrouter-config references	ResourceReference array
floating_ip_back_refs optional	List of floating-ip references	ResourceReference array
link_aggregation_group_back_refs optional	List of link-aggregation-group references	ResourceReference array
virtual_router_back_refs optional	List of virtual-router references	ResourceReference array
port_profile_back_refs optional	List of port-profile references	ResourceReference array
policy_management_back_refs optional	List of policy-management references	ResourceReference array
e2_service_provider_back_refs optional	List of e2-service-provider references	ResourceReference array
fabric_back_refs optional	List of fabric references	ResourceReference array
job_template_back_refs optional	List of job-template references	ResourceReference array
routing_policy_back_refs optional	List of routing-policy references	ResourceReference array
role_config_back_refs optional	List of role-config references	ResourceReference array
tag_type_back_refs optional	List of tag-type references	ResourceReference array
structured_syslog_message_back_refs optional	List of structured-syslog-message references	ResourceReference array
loadbalancer_pool_back_refs optional	List of loadbalancer-pool references	ResourceReference array
device_chassis_back_refs optional	List of device-chassis references	ResourceReference array
global_qos_config_back_refs optional	List of global-qos-config references	ResourceReference array
analytics_node_back_refs optional	List of analytics-node references	ResourceReference array
virtual_DNS_back_refs optional	List of virtual-DNS references	ResourceReference array
config_database_node_back_refs optional	List of config-database-node references	ResourceReference array
config_node_back_refs optional	List of config-node references	ResourceReference array
device_functional_group_back_refs optional	List of device-functional-group references	ResourceReference array
firewall_rule_back_refs optional	List of firewall-rule references	ResourceReference array
bgpvpn_back_refs optional	List of bgpvpn references	ResourceReference array
role_definition_back_refs optional	List of role-definition references	ResourceReference array
service_connection_module_back_refs optional	List of service-connection-module references	ResourceReference array
security_group_back_refs optional	List of security-group references	ResourceReference array
database_node_back_refs optional	List of database-node references	ResourceReference array
loadbalancer_healthmonitor_back_refs optional	List of loadbalancer-healthmonitor references	ResourceReference array
devicemgr_node_back_refs optional	List of devicemgr-node references	ResourceReference array
project_back_refs optional	List of project references	ResourceReference array
fabric_namespace_back_refs optional	List of fabric-namespace references	ResourceReference array
network_ipam_back_refs optional	List of network-ipam references	ResourceReference array
config_properties_back_refs optional	List of config-properties references	ResourceReference array
network_policy_back_refs optional	List of network-policy references	ResourceReference array
sflow_profile_back_refs optional	List of sflow-profile references	ResourceReference array
hardware_back_refs optional	List of hardware references	ResourceReference array
tag_back_refs optional	List of tag references	ResourceReference array
feature_config_back_refs optional	List of feature-config references	ResourceReference array
telemetry_profile_back_refs optional	List of telemetry-profile references	ResourceReference array
bgp_router_back_refs optional	List of bgp-router references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
virtual_port_group_back_refs optional	List of virtual-port-group references	ResourceReference array
service_appliance_back_refs optional	List of service-appliance references	ResourceReference array
namespace_back_refs optional	List of namespace references	ResourceReference array
feature_back_refs optional	List of feature references	ResourceReference array
storm_control_profile_back_refs optional	List of storm-control-profile references	ResourceReference array
device_image_back_refs optional	List of device-image references	ResourceReference array
physical_interface_back_refs optional	List of physical-interface references	ResourceReference array
access_control_list_back_refs optional	List of access-control-list references	ResourceReference array
snmp_profile_back_refs optional	List of snmp-profile references	ResourceReference array
node_back_refs optional	List of node references	ResourceReference array
grpc_profile_back_refs optional	List of grpc-profile references	ResourceReference array
customer_attachment_back_refs optional	List of customer-attachment references	ResourceReference array
structured_syslog_sla_profile_back_refs optional	List of structured-syslog-sla-profile references	ResourceReference array
host_based_service_back_refs optional	List of host-based-service references	ResourceReference array
virtual_machine_back_refs optional	List of virtual-machine references	ResourceReference array
interface_route_table_back_refs optional	List of interface-route-table references	ResourceReference array
loadbalancer_member_back_refs optional	List of loadbalancer-member references	ResourceReference array
service_health_check_back_refs optional	List of service-health-check references	ResourceReference array
alarm_back_refs optional	List of alarm references	ResourceReference array
api_access_list_back_refs optional	List of api-access-list references	ResourceReference array
routing_instance_back_refs optional	List of routing-instance references	ResourceReference array
alias_ip_pool_back_refs optional	List of alias-ip-pool references	ResourceReference array
data_center_interconnect_back_refs optional	List of data-center-interconnect references	ResourceReference array

TagUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_type_refs optional	List of tag-type references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

TagTypeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

TagTypeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
tag_type_id optional	Internal Tag type ID coded on 16 bits where the first 255 IDs are reserved and pre-defined. Users (principally cloud admin) can define arbitrary types but its automatically shared to all project as it is a global resource.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

TagTypeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
tag_type_id optional	Internal Tag type ID coded on 16 bits where the first 255 IDs are reserved and pre-defined. Users (principally cloud admin) can define arbitrary types but its automatically shared to all project as it is a global resource.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
tag_back_refs optional	List of tag references	ResourceReference array

TagTypeUpdate

Name	Description	Schema
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

TelemetryProfileCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
telemetry_profile_is_default optional	This attribute indicates whether it is a default telemetry profile or not. Default profiles are non- editable.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
sflow_profile_refs optional	List of sflow-profile references	ResourceReference array
grpc_profile_refs optional	List of grpc-profile references	ResourceReference array
netconf_profile_refs optional	List of netconf-profile references	ResourceReference array
snmp_profile_refs optional	List of snmp-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

TelemetryProfileReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
telemetry_profile_is_default optional	This attribute indicates whether it is a default telemetry profile or not. Default profiles are non- editable.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
sflow_profile_refs optional	List of sflow-profile references	ResourceReference array
grpc_profile_refs optional	List of grpc-profile references	ResourceReference array
netconf_profile_refs optional	List of netconf-profile references	ResourceReference array
snmp_profile_refs optional	List of snmp-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

TelemetryProfileReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
telemetry_profile_is_default optional	This attribute indicates whether it is a default telemetry profile or not. Default profiles are non- editable.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
sflow_profile_refs optional	List of sflow-profile references	ResourceReference array
grpc_profile_refs optional	List of grpc-profile references	ResourceReference array
netconf_profile_refs optional	List of netconf-profile references	ResourceReference array
snmp_profile_refs optional	List of snmp-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array

TelemetryProfileUpdate

Name	Description	Schema
telemetry_profile_is_default optional	This attribute indicates whether it is a default telemetry profile or not. Default profiles are non- editable.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
sflow_profile_refs optional	List of sflow-profile references	ResourceReference array
grpc_profile_refs optional	List of grpc-profile references	ResourceReference array
netconf_profile_refs optional	List of netconf-profile references	ResourceReference array
snmp_profile_refs optional	List of snmp-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘domain’]
virtual_DNS_data required	Virtual DNS data has configuration for virtual DNS like domain, dynamic records etc.	VirtualDnsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_DNS_data optional	Virtual DNS data has configuration for virtual DNS like domain, dynamic records etc.	VirtualDnsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_DNS_data optional	Virtual DNS data has configuration for virtual DNS like domain, dynamic records etc.	VirtualDnsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array
network_ipam_back_refs optional	List of network-ipam references	ResourceReference array

VirtualDnsUpdate

Name	Description	Schema
virtual_DNS_data optional	Virtual DNS data has configuration for virtual DNS like domain, dynamic records etc.	VirtualDnsType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsRecordCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-DNS’]
virtual_DNS_record_data required	DNS record data has configuration like type, name, ip address, loadbalancing etc.	VirtualDnsRecordType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsRecordReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_DNS_record_data optional	DNS record data has configuration like type, name, ip address, loadbalancing etc.	VirtualDnsRecordType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsRecordReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_DNS_record_data optional	DNS record data has configuration like type, name, ip address, loadbalancing etc.	VirtualDnsRecordType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualDnsRecordUpdate

Name	Description	Schema
virtual_DNS_record_data optional	DNS record data has configuration like type, name, ip address, loadbalancing etc.	VirtualDnsRecordType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

VirtualIpCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
virtual_ip_properties required	Virtual ip configuration like port, protocol, subnet etc.	VirtualIpType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_pool_refs optional	List of loadbalancer-pool references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualIpReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_ip_properties optional	Virtual ip configuration like port, protocol, subnet etc.	VirtualIpType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_pool_refs optional	List of loadbalancer-pool references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualIpReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_ip_properties optional	Virtual ip configuration like port, protocol, subnet etc.	VirtualIpType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_pool_refs optional	List of loadbalancer-pool references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualIpUpdate

Name	Description	Schema
virtual_ip_properties optional	Virtual ip configuration like port, protocol, subnet etc.	VirtualIpType
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
loadbalancer_pool_refs optional	List of loadbalancer-pool references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualMachineCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
server_type optional	An enumeration value specifying the server type.	Any of [‘virtual-server’, ‘baremetal-server’, ‘container’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualMachineReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
server_type optional	An enumeration value specifying the server type.	Any of [‘virtual-server’, ‘baremetal-server’, ‘container’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualMachineReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
server_type optional	An enumeration value specifying the server type.	Any of [‘virtual-server’, ‘baremetal-server’, ‘container’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_router_back_refs optional	List of virtual-router references	ResourceReference array

VirtualMachineUpdate

Name	Description	Schema
server_type optional	An enumeration value specifying the server type.	Any of [‘virtual-server’, ‘baremetal-server’, ‘container’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
service_instance_refs optional	List of service-instance references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualMachineInterfaceCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘virtual-machine’, ‘project’, ‘virtual-router’]
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
port_security_enabled optional	Port security status on the network	boolean
virtual_machine_interface_mac_addresses required	MAC address of the virtual machine interface, automatically assigned by system if not provided.	MacAddressesType
virtual_machine_interface_dhcp_option_list optional	DHCP options configuration specific to this interface.	DhcpOptionsListType
virtual_machine_interface_host_routes optional	List of host routes(prefixes, nexthop) that are passed to VM via DHCP.	RouteTableType
virtual_machine_interface_allowed_address_pairs optional	List of (IP address, MAC) other than instance ip on this interface.	AllowedAddressPairs
vrf_assign_table optional	VRF assignment policy for this interface, automatically generated by system.	VrfAssignTableType
virtual_machine_interface_device_owner optional	For openstack compatibility, not used by system.	string
virtual_machine_interface_disable_policy optional	When True all policy checks for ingress and egress traffic from this interface are disabled. Flow table entries are not created. Features that require policy will not work on this interface, these include security group, floating IP, service chain, linklocal services.	boolean
virtual_machine_interface_properties optional	Virtual Machine Interface miscellaneous configurations.	VirtualMachineInterfacePropertiesType
virtual_machine_interface_bindings optional	Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.	KeyValuePairs
virtual_machine_interface_fat_flow_protocols optional	List of (protocol, port number), for flows to interface with (protocol, destination port number), vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow. Hence many flows will map to single flow.	FatFlowProtocols
vlan_tag_based_bridge_domain optional	Enable VLAN tag based bridge domain classification on the port	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
virtual_network_refs required	List of virtual-network references	ResourceReference array
routing_instance_refs optional	List of routing-instance references	VirtualMachineInterfaceRoutingInstanceRefs array
bgp_router_refs required	List of bgp-router references	ResourceReference array
port_tuple_refs optional	List of port-tuple references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
physical_interface_refs optional	List of physical-interface references	ResourceReference array
bridge_domain_refs optional	List of bridge-domain references	VirtualMachineInterfaceBridgeDomainRefs array
service_endpoint_refs optional	List of service-endpoint references	ResourceReference array
virtual_port_group_refs optional	List of virtual-port-group references	VirtualMachineInterfaceVirtualPortGroupRefs array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualMachineInterfaceReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
port_security_enabled optional	Port security status on the network	boolean
virtual_machine_interface_mac_addresses optional	MAC address of the virtual machine interface, automatically assigned by system if not provided.	MacAddressesType
virtual_machine_interface_dhcp_option_list optional	DHCP options configuration specific to this interface.	DhcpOptionsListType
virtual_machine_interface_host_routes optional	List of host routes(prefixes, nexthop) that are passed to VM via DHCP.	RouteTableType
virtual_machine_interface_allowed_address_pairs optional	List of (IP address, MAC) other than instance ip on this interface.	AllowedAddressPairs
vrf_assign_table optional	VRF assignment policy for this interface, automatically generated by system.	VrfAssignTableType
virtual_machine_interface_device_owner optional	For openstack compatibility, not used by system.	string
virtual_machine_interface_disable_policy optional	When True all policy checks for ingress and egress traffic from this interface are disabled. Flow table entries are not created. Features that require policy will not work on this interface, these include security group, floating IP, service chain, linklocal services.	boolean
virtual_machine_interface_properties optional	Virtual Machine Interface miscellaneous configurations.	VirtualMachineInterfacePropertiesType
virtual_machine_interface_bindings optional	Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.	KeyValuePairs
virtual_machine_interface_fat_flow_protocols optional	List of (protocol, port number), for flows to interface with (protocol, destination port number), vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow. Hence many flows will map to single flow.	FatFlowProtocols
vlan_tag_based_bridge_domain optional	Enable VLAN tag based bridge domain classification on the port	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_instance_refs optional	List of routing-instance references	VirtualMachineInterfaceRoutingInstanceRefs array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
port_tuple_refs optional	List of port-tuple references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
physical_interface_refs optional	List of physical-interface references	ResourceReference array
bridge_domain_refs optional	List of bridge-domain references	VirtualMachineInterfaceBridgeDomainRefs array
service_endpoint_refs optional	List of service-endpoint references	ResourceReference array
virtual_port_group_refs optional	List of virtual-port-group references	VirtualMachineInterfaceVirtualPortGroupRefs array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualMachineInterfaceReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
port_security_enabled optional	Port security status on the network	boolean
virtual_machine_interface_mac_addresses optional	MAC address of the virtual machine interface, automatically assigned by system if not provided.	MacAddressesType
virtual_machine_interface_dhcp_option_list optional	DHCP options configuration specific to this interface.	DhcpOptionsListType
virtual_machine_interface_host_routes optional	List of host routes(prefixes, nexthop) that are passed to VM via DHCP.	RouteTableType
virtual_machine_interface_allowed_address_pairs optional	List of (IP address, MAC) other than instance ip on this interface.	AllowedAddressPairs
vrf_assign_table optional	VRF assignment policy for this interface, automatically generated by system.	VrfAssignTableType
virtual_machine_interface_device_owner optional	For openstack compatibility, not used by system.	string
virtual_machine_interface_disable_policy optional	When True all policy checks for ingress and egress traffic from this interface are disabled. Flow table entries are not created. Features that require policy will not work on this interface, these include security group, floating IP, service chain, linklocal services.	boolean
virtual_machine_interface_properties optional	Virtual Machine Interface miscellaneous configurations.	VirtualMachineInterfacePropertiesType
virtual_machine_interface_bindings optional	Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.	KeyValuePairs
virtual_machine_interface_fat_flow_protocols optional	List of (protocol, port number), for flows to interface with (protocol, destination port number), vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow. Hence many flows will map to single flow.	FatFlowProtocols
vlan_tag_based_bridge_domain optional	Enable VLAN tag based bridge domain classification on the port	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_instance_refs optional	List of routing-instance references	VirtualMachineInterfaceRoutingInstanceRefs array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
port_tuple_refs optional	List of port-tuple references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
physical_interface_refs optional	List of physical-interface references	ResourceReference array
bridge_domain_refs optional	List of bridge-domain references	VirtualMachineInterfaceBridgeDomainRefs array
service_endpoint_refs optional	List of service-endpoint references	ResourceReference array
virtual_port_group_refs optional	List of virtual-port-group references	VirtualMachineInterfaceVirtualPortGroupRefs array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array
subnet_back_refs optional	List of subnet references	ResourceReference array
floating_ip_back_refs optional	List of floating-ip references	ResourceReference array
alias_ip_back_refs optional	List of alias-ip references	ResourceReference array
logical_interface_back_refs optional	List of logical-interface references	ResourceReference array
bgp_as_a_service_back_refs optional	List of bgp-as-a-service references	ResourceReference array
customer_attachment_back_refs optional	List of customer-attachment references	ResourceReference array
logical_router_back_refs optional	List of logical-router references	ResourceReference array
loadbalancer_pool_back_refs optional	List of loadbalancer-pool references	ResourceReference array
virtual_ip_back_refs optional	List of virtual-ip references	ResourceReference array
loadbalancer_back_refs optional	List of loadbalancer references	ResourceReference array
virtual_port_group_back_refs optional	List of virtual-port-group references	ResourceReference array
link_aggregation_group_back_refs optional	List of link-aggregation-group references	ResourceReference array

VirtualMachineInterfaceUpdate

Name	Description	Schema
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
port_security_enabled optional	Port security status on the network	boolean
virtual_machine_interface_mac_addresses optional	MAC address of the virtual machine interface, automatically assigned by system if not provided.	MacAddressesType
virtual_machine_interface_dhcp_option_list optional	DHCP options configuration specific to this interface.	DhcpOptionsListType
virtual_machine_interface_host_routes optional	List of host routes(prefixes, nexthop) that are passed to VM via DHCP.	RouteTableType
virtual_machine_interface_allowed_address_pairs optional	List of (IP address, MAC) other than instance ip on this interface.	AllowedAddressPairs
vrf_assign_table optional	VRF assignment policy for this interface, automatically generated by system.	VrfAssignTableType
virtual_machine_interface_device_owner optional	For openstack compatibility, not used by system.	string
virtual_machine_interface_disable_policy optional	When True all policy checks for ingress and egress traffic from this interface are disabled. Flow table entries are not created. Features that require policy will not work on this interface, these include security group, floating IP, service chain, linklocal services.	boolean
virtual_machine_interface_properties optional	Virtual Machine Interface miscellaneous configurations.	VirtualMachineInterfacePropertiesType
virtual_machine_interface_bindings optional	Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.	KeyValuePairs
virtual_machine_interface_fat_flow_protocols optional	List of (protocol, port number), for flows to interface with (protocol, destination port number), vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow. Hence many flows will map to single flow.	FatFlowProtocols
vlan_tag_based_bridge_domain optional	Enable VLAN tag based bridge domain classification on the port	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
routing_instance_refs optional	List of routing-instance references	VirtualMachineInterfaceRoutingInstanceRefs array
bgp_router_refs optional	List of bgp-router references	ResourceReference array
port_tuple_refs optional	List of port-tuple references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
interface_route_table_refs optional	List of interface-route-table references	ResourceReference array
physical_interface_refs optional	List of physical-interface references	ResourceReference array
bridge_domain_refs optional	List of bridge-domain references	VirtualMachineInterfaceBridgeDomainRefs array
service_endpoint_refs optional	List of service-endpoint references	ResourceReference array
virtual_port_group_refs optional	List of virtual-port-group references	VirtualMachineInterfaceVirtualPortGroupRefs array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualNetworkCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘project’]
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
virtual_network_category optional	This attribute is to differentiate the infrastructure networks from the tenant and routed networks. Infra-networks could be in-band network for management and control traffic	Any of [‘infra’, ‘tenant’, ‘internal’, ‘routed’]
virtual_network_properties optional	Virtual network miscellaneous configurations.	VirtualNetworkType
virtual_network_routed_properties optional	Attributes for routed virtual networks.	VirtualNetworkRoutedPropertiesType
provider_properties optional	Virtual network is provider network. Specifies VLAN tag and physical network name.	ProviderDetails
virtual_network_network_id optional	System assigned unique 32 bit ID for every virtual network.	number
port_security_enabled optional	Port security status on the network	boolean
fabric_snat optional	Provide connectivity to underlay network by port mapping	boolean
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
router_external optional	When true, this virtual network is openstack router external network.	boolean
is_shared optional	When true, this virtual network is shared with all tenants.	boolean
mtu optional	MTU attribute for the virtual network	number
external_ipam optional	IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only feature.	boolean
flood_unknown_unicast optional	When true, packets with unknown unicast MAC address are flooded within the network. Default they are dropped.	boolean
multi_policy_service_chains_enabled optional	Allow multiple service chains within same two networks based on network policy. Current limitation is that both networks must reside within cluster, except when right most service is NAT.	boolean
address_allocation_mode optional	Address allocation mode for virtual network.	Any of [‘user-defined-subnet-preferred’, ‘user-defined-subnet-only’, ‘flat-subnet-preferred’, ‘flat-subnet-only’]
virtual_network_fat_flow_protocols optional	Fat flow configuration which is a list, will be applied to all the interfaces in the specified virtual-network	FatFlowProtocols
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
pbb_evpn_enable optional	Enable/Disable PBB EVPN tunneling on the network	boolean
pbb_etree_enable optional	Enable/Disable PBB ETREE mode on the network	boolean
layer2_control_word optional	Enable/Disable adding control word to the Layer 2 encapsulation	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
mac_ip_learning_enable optional	Enable/Disable MAC-IP Learning on the network	boolean
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
network_ipam_refs required	List of network-ipam references	VirtualNetworkNetworkIpamRefs array
network_policy_refs optional	List of network-policy references	VirtualNetworkNetworkPolicyRefs array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
multicast_policy_refs optional	List of multicast-policy references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	VirtualNetworkRoutingPolicyRefs array
tag_refs optional	List of tag references	ResourceReference array

VirtualNetworkReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
virtual_network_category optional	This attribute is to differentiate the infrastructure networks from the tenant and routed networks. Infra-networks could be in-band network for management and control traffic	Any of [‘infra’, ‘tenant’, ‘internal’, ‘routed’]
virtual_network_properties optional	Virtual network miscellaneous configurations.	VirtualNetworkType
virtual_network_routed_properties optional	Attributes for routed virtual networks.	VirtualNetworkRoutedPropertiesType
provider_properties optional	Virtual network is provider network. Specifies VLAN tag and physical network name.	ProviderDetails
virtual_network_network_id optional	System assigned unique 32 bit ID for every virtual network.	number
is_provider_network optional	provider network status of the virtual-network.	boolean
port_security_enabled optional	Port security status on the network	boolean
fabric_snat optional	Provide connectivity to underlay network by port mapping	boolean
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
router_external optional	When true, this virtual network is openstack router external network.	boolean
is_shared optional	When true, this virtual network is shared with all tenants.	boolean
mtu optional	MTU attribute for the virtual network	number
external_ipam optional	IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only feature.	boolean
flood_unknown_unicast optional	When true, packets with unknown unicast MAC address are flooded within the network. Default they are dropped.	boolean
multi_policy_service_chains_enabled optional	Allow multiple service chains within same two networks based on network policy. Current limitation is that both networks must reside within cluster, except when right most service is NAT.	boolean
address_allocation_mode optional	Address allocation mode for virtual network.	Any of [‘user-defined-subnet-preferred’, ‘user-defined-subnet-only’, ‘flat-subnet-preferred’, ‘flat-subnet-only’]
virtual_network_fat_flow_protocols optional	Fat flow configuration which is a list, will be applied to all the interfaces in the specified virtual-network	FatFlowProtocols
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
pbb_evpn_enable optional	Enable/Disable PBB EVPN tunneling on the network	boolean
pbb_etree_enable optional	Enable/Disable PBB ETREE mode on the network	boolean
layer2_control_word optional	Enable/Disable adding control word to the Layer 2 encapsulation	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
mac_ip_learning_enable optional	Enable/Disable MAC-IP Learning on the network	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
network_ipam_refs optional	List of network-ipam references	VirtualNetworkNetworkIpamRefs array
network_policy_refs optional	List of network-policy references	VirtualNetworkNetworkPolicyRefs array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
multicast_policy_refs optional	List of multicast-policy references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	VirtualNetworkRoutingPolicyRefs array
tag_refs optional	List of tag references	ResourceReference array

VirtualNetworkReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
virtual_network_category optional	This attribute is to differentiate the infrastructure networks from the tenant and routed networks. Infra-networks could be in-band network for management and control traffic	Any of [‘infra’, ‘tenant’, ‘internal’, ‘routed’]
virtual_network_properties optional	Virtual network miscellaneous configurations.	VirtualNetworkType
virtual_network_routed_properties optional	Attributes for routed virtual networks.	VirtualNetworkRoutedPropertiesType
provider_properties optional	Virtual network is provider network. Specifies VLAN tag and physical network name.	ProviderDetails
virtual_network_network_id optional	System assigned unique 32 bit ID for every virtual network.	number
is_provider_network optional	provider network status of the virtual-network.	boolean
port_security_enabled optional	Port security status on the network	boolean
fabric_snat optional	Provide connectivity to underlay network by port mapping	boolean
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
router_external optional	When true, this virtual network is openstack router external network.	boolean
is_shared optional	When true, this virtual network is shared with all tenants.	boolean
mtu optional	MTU attribute for the virtual network	number
external_ipam optional	IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only feature.	boolean
flood_unknown_unicast optional	When true, packets with unknown unicast MAC address are flooded within the network. Default they are dropped.	boolean
multi_policy_service_chains_enabled optional	Allow multiple service chains within same two networks based on network policy. Current limitation is that both networks must reside within cluster, except when right most service is NAT.	boolean
address_allocation_mode optional	Address allocation mode for virtual network.	Any of [‘user-defined-subnet-preferred’, ‘user-defined-subnet-only’, ‘flat-subnet-preferred’, ‘flat-subnet-only’]
virtual_network_fat_flow_protocols optional	Fat flow configuration which is a list, will be applied to all the interfaces in the specified virtual-network	FatFlowProtocols
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
pbb_evpn_enable optional	Enable/Disable PBB EVPN tunneling on the network	boolean
pbb_etree_enable optional	Enable/Disable PBB ETREE mode on the network	boolean
layer2_control_word optional	Enable/Disable adding control word to the Layer 2 encapsulation	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
mac_ip_learning_enable optional	Enable/Disable MAC-IP Learning on the network	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
network_ipam_refs optional	List of network-ipam references	VirtualNetworkNetworkIpamRefs array
network_policy_refs optional	List of network-policy references	VirtualNetworkNetworkPolicyRefs array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
multicast_policy_refs optional	List of multicast-policy references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	VirtualNetworkRoutingPolicyRefs array
tag_refs optional	List of tag references	ResourceReference array
virtual_network_back_refs optional	List of virtual-network references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
port_tuple_back_refs optional	List of port-tuple references	ResourceReference array
logical_router_back_refs optional	List of logical-router back references	LogicalRouterVirtualNetworkRefs array
flow_node_back_refs optional	List of flow-node references	ResourceReference array
firewall_rule_back_refs optional	List of firewall-rule references	ResourceReference array
data_center_interconnect_back_refs optional	List of data-center-interconnect references	ResourceReference array
fabric_back_refs optional	List of fabric back references	FabricVirtualNetworkRefs array
host_based_service_back_refs optional	List of host-based-service back references	HostBasedServiceVirtualNetworkRefs array

VirtualNetworkUpdate

Name	Description	Schema
ecmp_hashing_include_fields optional	ECMP hashing config at global level.	EcmpHashingIncludeFields
virtual_network_category optional	This attribute is to differentiate the infrastructure networks from the tenant and routed networks. Infra-networks could be in-band network for management and control traffic	Any of [‘infra’, ‘tenant’, ‘internal’, ‘routed’]
virtual_network_properties optional	Virtual network miscellaneous configurations.	VirtualNetworkType
virtual_network_routed_properties optional	Attributes for routed virtual networks.	VirtualNetworkRoutedPropertiesType
port_security_enabled optional	Port security status on the network	boolean
fabric_snat optional	Provide connectivity to underlay network by port mapping	boolean
route_target_list optional	List of route targets that are used as both import and export for this virtual network.	RouteTargetList
import_route_target_list optional	List of route targets that are used as import for this virtual network.	RouteTargetList
export_route_target_list optional	List of route targets that are used as export for this virtual network.	RouteTargetList
router_external optional	When true, this virtual network is openstack router external network.	boolean
is_shared optional	When true, this virtual network is shared with all tenants.	boolean
mtu optional	MTU attribute for the virtual network	number
external_ipam optional	IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only feature.	boolean
flood_unknown_unicast optional	When true, packets with unknown unicast MAC address are flooded within the network. Default they are dropped.	boolean
multi_policy_service_chains_enabled optional	Allow multiple service chains within same two networks based on network policy. Current limitation is that both networks must reside within cluster, except when right most service is NAT.	boolean
address_allocation_mode optional	Address allocation mode for virtual network.	Any of [‘user-defined-subnet-preferred’, ‘user-defined-subnet-only’, ‘flat-subnet-preferred’, ‘flat-subnet-only’]
virtual_network_fat_flow_protocols optional	Fat flow configuration which is a list, will be applied to all the interfaces in the specified virtual-network	FatFlowProtocols
mac_learning_enabled optional	Enable MAC learning on the network	boolean
mac_limit_control optional	MAC limit control on the network	MACLimitControlType
mac_move_control optional	MAC move control on the network	MACMoveLimitControlType
mac_aging_time optional	MAC aging time on the network	number
pbb_evpn_enable optional	Enable/Disable PBB EVPN tunneling on the network	boolean
pbb_etree_enable optional	Enable/Disable PBB ETREE mode on the network	boolean
layer2_control_word optional	Enable/Disable adding control word to the Layer 2 encapsulation	boolean
igmp_enable optional	IGMP mode at Global level.	boolean
mac_ip_learning_enable optional	Enable/Disable MAC-IP Learning on the network	boolean
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
security_logging_object_refs optional	List of security-logging-object references	ResourceReference array
qos_config_refs optional	List of qos-config references	ResourceReference array
network_ipam_refs optional	List of network-ipam references	VirtualNetworkNetworkIpamRefs array
network_policy_refs optional	List of network-policy references	VirtualNetworkNetworkPolicyRefs array
virtual_network_refs optional	List of virtual-network references	ResourceReference array
service_health_check_refs optional	List of service-health-check references	ResourceReference array
route_table_refs optional	List of route-table references	ResourceReference array
multicast_policy_refs optional	List of multicast-policy references	ResourceReference array
bgpvpn_refs optional	List of bgpvpn references	ResourceReference array
intent_map_refs optional	List of intent-map references	ResourceReference array
routing_policy_refs optional	List of routing-policy references	VirtualNetworkRoutingPolicyRefs array
tag_refs optional	List of tag references	ResourceReference array

VirtualPortGroupCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘fabric’, ‘project’]
virtual_port_group_lacp_enabled required	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
virtual_port_group_trunk_port_id required	id of the port that enables multi valn trunking.	string
virtual_port_group_user_created optional	Flag to be set to True when its externally created and False when created internally. Default is set to True	boolean
virtual_port_group_type optional	Type of Virtual port group. It can be either access i.e L2 connectivity or routed.	Any of [‘access’, ‘routed’]
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	VirtualPortGroupPhysicalInterfaceRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualPortGroupReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_port_group_lacp_enabled optional	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
virtual_port_group_trunk_port_id optional	id of the port that enables multi valn trunking.	string
virtual_port_group_user_created optional	Flag to be set to True when its externally created and False when created internally. Default is set to True	boolean
virtual_port_group_type optional	Type of Virtual port group. It can be either access i.e L2 connectivity or routed.	Any of [‘access’, ‘routed’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	VirtualPortGroupPhysicalInterfaceRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualPortGroupReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_port_group_lacp_enabled optional	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
virtual_port_group_trunk_port_id optional	id of the port that enables multi valn trunking.	string
virtual_port_group_user_created optional	Flag to be set to True when its externally created and False when created internally. Default is set to True	boolean
virtual_port_group_type optional	Type of Virtual port group. It can be either access i.e L2 connectivity or routed.	Any of [‘access’, ‘routed’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	VirtualPortGroupPhysicalInterfaceRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
virtual_machine_interface_back_refs optional	List of virtual-machine-interface back references	VirtualMachineInterfaceVirtualPortGroupRefs array

VirtualPortGroupUpdate

Name	Description	Schema
virtual_port_group_lacp_enabled optional	Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.	boolean
virtual_port_group_user_created optional	Flag to be set to True when its externally created and False when created internally. Default is set to True	boolean
virtual_port_group_type optional	Type of Virtual port group. It can be either access i.e L2 connectivity or routed.	Any of [‘access’, ‘routed’]
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
physical_interface_refs optional	List of physical-interface references	VirtualPortGroupPhysicalInterfaceRefs array
virtual_machine_interface_refs optional	List of virtual-machine-interface references	ResourceReference array
security_group_refs optional	List of security-group references	ResourceReference array
port_profile_refs optional	List of port-profile references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualRouterCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
virtual_router_type optional	Different types of the vrouters in the system.	Any of [‘embedded’, ‘tor-agent’, ‘tor-service-node’]
virtual_router_dpdk_enabled optional	This vrouter’s data path is using DPDK library, Virtual machines interfaces scheduled on this compute node will be tagged with additional flags so that they are spawned with user space virtio driver. It is only applicable for embedded vrouter.	boolean
virtual_router_sriov_physical_networks optional	Dictionary of (physnet, interface) mapping for this virtual router.	KeyValuePairs
virtual_router_ip_address required	Ip address of the virtual router.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_ipam_refs optional	List of network-ipam references	VirtualRouterNetworkIpamRefs array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualRouterReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_router_type optional	Different types of the vrouters in the system.	Any of [‘embedded’, ‘tor-agent’, ‘tor-service-node’]
virtual_router_dpdk_enabled optional	This vrouter’s data path is using DPDK library, Virtual machines interfaces scheduled on this compute node will be tagged with additional flags so that they are spawned with user space virtio driver. It is only applicable for embedded vrouter.	boolean
virtual_router_sriov_physical_networks optional	Dictionary of (physnet, interface) mapping for this virtual router.	KeyValuePairs
virtual_router_ip_address optional	Ip address of the virtual router.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_ipam_refs optional	List of network-ipam references	VirtualRouterNetworkIpamRefs array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

VirtualRouterReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
virtual_router_type optional	Different types of the vrouters in the system.	Any of [‘embedded’, ‘tor-agent’, ‘tor-service-node’]
virtual_router_dpdk_enabled optional	This vrouter’s data path is using DPDK library, Virtual machines interfaces scheduled on this compute node will be tagged with additional flags so that they are spawned with user space virtio driver. It is only applicable for embedded vrouter.	boolean
virtual_router_sriov_physical_networks optional	Dictionary of (physnet, interface) mapping for this virtual router.	KeyValuePairs
virtual_router_ip_address optional	Ip address of the virtual router.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_ipam_refs optional	List of network-ipam references	VirtualRouterNetworkIpamRefs array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array
instance_ip_back_refs optional	List of instance-ip references	ResourceReference array
physical_router_back_refs optional	List of physical-router references	ResourceReference array
provider_attachment_back_refs optional	List of provider-attachment references	ResourceReference array

VirtualRouterUpdate

Name	Description	Schema
virtual_router_dpdk_enabled optional	This vrouter’s data path is using DPDK library, Virtual machines interfaces scheduled on this compute node will be tagged with additional flags so that they are spawned with user space virtio driver. It is only applicable for embedded vrouter.	boolean
virtual_router_sriov_physical_networks optional	Dictionary of (physnet, interface) mapping for this virtual router.	KeyValuePairs
virtual_router_ip_address optional	Ip address of the virtual router.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
network_ipam_refs optional	List of network-ipam references	VirtualRouterNetworkIpamRefs array
sub_cluster_refs optional	List of sub-cluster references	ResourceReference array
virtual_machine_refs optional	List of virtual-machine references	ResourceReference array
tag_refs optional	List of tag references	ResourceReference array

WebuiNodeCreate

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
parent_type required	Parent resource type	Any of [‘global-system-config’]
webui_node_ip_address required	Ip address of the webui node, set while provisioning.	string
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

WebuiNodeReadDetail

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
webui_node_ip_address optional	Ip address of the webui node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

WebuiNodeReadAll

Name	Description	Schema
fq_name required	Fully Qualified Name of resource	< string > array
webui_node_ip_address optional	Ip address of the webui node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
perms2 optional	Permissions data for role based access.	PermType2
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

WebuiNodeUpdate

Name	Description	Schema
webui_node_ip_address optional	Ip address of the webui node, set while provisioning.	string
id_perms optional	System maintained identity, time and permissions data.	IdPermsType
annotations optional	Dictionary of arbitrary (key, value) on a resource.	KeyValuePairs
display_name optional	Display name user configured string(name) that can be updated any time. Used as openstack name.	string
tag_refs optional	List of tag references	ResourceReference array

AlarmAndList

Name	Description	Schema
and_list optional		AlarmExpression

UserDefinedLogStat

Name	Description	Schema
name required	Name of the stat	string
pattern required	Perl type regular expression pattern to match	string

ServicePropertiesType

Name	Description	Schema
retain_as_path optional	Indicates if as-path should be retained across service-instances in the service- chain	boolean

LogicalRouterPRListParams

Name	Description	Schema
logical_router_uuid required	stores destination logical router uuid for dci intra-fabric type.	string
physical_router_uuid_list required	list of physical routers uuid exists in current destination logical-router and user has selected this PR for dci intra-fabric route leaks.	string

ServiceAppliancePhysicalInterfaceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ServiceApplianceInterfaceType

StructuredSyslogLinkType

Name	Description	Schema
overlay optional		string
underlay optional		string
link_type optional		string
traffic_destination optional		string
metadata optional		string

StructuredSyslogDSCPType

Name	Description	Schema
dscp_value optional		string
alias_code optional		string

VirtualRouterNetworkIpamRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		VirtualRouterNetworkIpamType

PortInfoType

Name	Description	Schema
name optional		string
type optional		Any of [‘fc’, ‘ge’, ‘xe’, ‘xle’, ‘et’, ‘fte’, ‘me’, ‘em’]
port_speed optional		Any of [‘1G’, ‘10G’, ‘40G’, ‘100G’]
channelized optional		boolean
channelized_port_speed optional		Any of [‘1G’, ‘10G’, ‘40G’, ‘100G’]
port_group optional		string
labels optional		string

PolicyRuleType

Name	Description	Schema
rule_sequence optional	Deprecated, Will be removed because rules themselves are already an ordered list	SequenceType
rule_uuid optional	Rule UUID is identifier used in flow records to identify rule	string
direction required		Any of [‘>’, ‘<>’]
protocol required	Layer 4 protocol in ip packet	string
src_addresses required	Source ip matching criteria	AddressType
src_ports required	Range of source port for layer 4 protocol	PortType
application optional	Optionally application can be specified instead of protocol and port. not currently implemented	string
dst_addresses required	Destination ip matching criteria	AddressType
dst_ports required	Range of destination port for layer 4 protocol	PortType
action_list required	Actions to be performed if packets match condition	ActionListType
ethertype required		Any of [‘IPv4’, ‘IPv6’]
created optional	timestamp when security group rule object gets created	string
last_modified optional	timestamp when security group rule object gets updated	string
description optional	User provided text	string

AddressType

Name	Description	Schema
subnet optional	Any address that belongs to this subnet	SubnetType
virtual_network optional	Any address that belongs to this virtual network	string
security_group optional	Any address that belongs to interface with this security-group	string
network_policy optional	Any address that belongs to virtual network which has this policy attached	string
subnet_list optional	Any address that belongs to any one of subnet in this list	SubnetType

FabricVirtualNetworkRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		FabricNetworkTag

ApplicationPolicySetFirewallPolicyRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		FirewallSequence

PolicyTermType

Name	Description	Schema
term_match_condition optional		TermMatchConditionType
term_action_list optional		TermActionListType

IpamDnsAddressType

Name	Description	Schema
tenant_dns_server_address optional	In case of tenant DNS server method, Ip address of DNS server. This will be given in DHCP	IpAddressesType
virtual_dns_server_name optional	In case of virtual DNS server, name of virtual DNS server	string

TimerType

Name	Description	Schema
start_time required		string
on_interval required		string
off_interval required		string
end_time required		string

FabricNodeProfileRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		SerialNumListType

LocalLinkConnection

Name	Description	Schema
switch_info optional	UUID of the Physical-Port with contrail database	string
port_index optional	Port-Id provided by LLDP, This usually maps to SnmpIndex	string
port_id optional	Port ID of switch where Baremetal is connected	string
switch_id optional	Switch hostname	string

PluginProperty

Name	Description	Schema
property optional		string
value optional		string

StaticRouteType

Name	Description	Schema
prefix optional		string
next_hop optional		string
route_target optional		string
community optional		string

MirrorActionType

Name	Description	Schema
analyzer_name optional	Name of service instance used as analyzer	string
encapsulation optional	Encapsulation for Mirrored packet, not used currently	string
analyzer_ip_address required	ip address of interface to which mirrored packets are sent	string
analyzer_mac_address optional	mac address of interface to which mirrored packets are sent	string
routing_instance required	Routing instance for the virtual network which analyzer is in	string
udp_port optional	ip udp port used in contrail default encapsulation for mirroring	integer
juniper_header optional	This flag is used to determine with/without juniper-header	boolean
nh_mode optional	This mode used to determine static or dynamic nh	Any of [‘dynamic’, ‘static’]
static_nh_header optional	vtep details required if static nh enabled	StaticMirrorNhType
nic_assisted_mirroring optional	This flag is used to select nic assisted mirroring	boolean
nic_assisted_mirroring_vlan optional	The VLAN to be tagged on the traffic for NIC to Mirror	integer

ServiceInstanceInterfaceType

Name	Description	Schema
virtual_network required	Interface belongs to this virtual network.	string
ip_address optional	Shared ip for this interface (Only V1)	string
static_routes optional	Static routes for this interface (Only V1)	RouteTableType
allowed_address_pairs optional	Allowed address pairs, list of (IP address, MAC) for this interface	AllowedAddressPairs

StatsCollectionFrequency

Name	Description	Schema
sample_rate optional		integer
polling_interval optional		integer
direction optional		Any of [‘ingress’, ‘egress’]

SecurityLoggingObjectSecurityGroupRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		SecurityLoggingObjectRuleListType

RoutingInstanceRoutingInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ConnectionType

AclRuleType

Name	Description	Schema
match_condition required	Match condition for packets	MatchConditionType
action_list required	Actions to be performed if packets match condition	ActionListType
rule_uuid optional	Rule UUID is identifier used in flow records to identify rule	string
direction optional	Direction in the rule	Any of [‘>’, ‘<>’]

RoutingInstanceRouteTargetRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		InstanceTargetType

QosIdForwardingClassPair

Name	Description	Schema
key optional	QoS bit value (DSCP or Vlan priority or EXP bit value	integer
forwarding_class_id optional		integer

PortTranslationPool

Name	Description	Schema
protocol optional		string
port_range optional	Port range to be reserved for per layer 4 protocol for PAT	PortType
port_count optional	Number of ports per layer 4 protocol to be reserved for PAT	string

ProtocolOspfType

Name	Description	Schema
area optional		integer

PortMap

Name	Description	Schema
protocol optional		string
src_port optional		integer
dst_port optional		integer

TermMatchConditionType

Name	Description	Schema
protocol optional		Any of [‘xmpp’, ‘service-chain’, ‘interface’, ‘interface-static’, ‘service-interface’, ‘bgpaas’, ‘bgp’, ‘static’, ‘aggregate’, ‘direct’, ‘pim’, ‘evpn’, ‘ospf’, ‘ospf3’]
prefix optional		PrefixMatchType
community optional		string
community_list optional		string
community_match_all optional		boolean
extcommunity_list optional		string
extcommunity_match_all optional		boolean
family optional		Any of [‘inet’, ‘inet-vpn’, ‘evpn’]
as_path optional		integer
external optional		Any of [‘ospf-type-1’, ‘ospf-type-2’]
local_pref optional		integer
nlri_route_type optional	list of integer values in range of 1 to 10 inclusive.	integer
prefix_list optional	list of prefixes from interface route table uuids with prefix types.	PrefixListMatchType
route_filter optional		RouteFilterType

DriverInfo

Name	Description	Schema
ipmi_address optional	IPMI address of the server to manage boot device and power management	string
deploy_ramdisk optional	UUID of the deploy initrd/ramdisk	string
ipmi_password optional	Password to access IPMI	string
ipmi_port optional	Remote IPMI RMCP port	string
ipmi_username optional	Username to access IPMI	string
deploy_kernel optional	UUID of the deploy kernel	string

VirtualMachineInterfaceRoutingInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		PolicyBasedForwardingRuleType

VrfAssignRuleType

Name	Description	Schema
match_condition optional		MatchConditionType
vlan_tag optional		integer
routing_instance optional		string
ignore_acl optional		boolean

EnabledInterfaceParams

Name	Description	Schema
name optional		string
stats_collection_frequency optional		StatsCollectionFrequency

PortType

Name	Description	Schema
start_port required		integer
end_port required		integer

SequenceType

Name	Description	Schema
major required		integer
minor required		integer

AllocationPoolType

Name	Description	Schema
start optional		string
end optional		string
vrouter_specific_pool optional		boolean

VirtualNetworkRoutingPolicyRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		RoutingPolicyType

ProtocolType

Name	Description	Schema
protocol optional		string
port optional		integer
ignore_address optional	Address ignored while creating flows, from the perspective of packets egressing the VM. For packets originated by VM, source and destination indicate the corresponding IPs in the packet. For packets coming from remote source, source indicates destination IP of the packet is ignored and destination indicates source IP of the packet is ignored.	Any of [‘none’, ‘source’, ‘destination’]
source_prefix optional	For packets originated from VM source-prefix is applied to source IP of the packet. For packets coming to VM, source-prefix is applied to destination IP of the packet	SubnetType
source_aggregate_prefix_length optional	Fat flow prefix mask length for IP where source-prefix is applied	integer
destination_prefix optional	For packets originated from VM destination-prefix is applied to destination IP of the packet. For packets coming to VM, destination-prefix is applied to source IP of the packet	SubnetType
destination_aggregate_prefix_length optional	Fat flow prefix mask length for IP where destination-prefix is applied	integer

EnabledSensorParams

Name	Description	Schema
physical_health optional		boolean
interface_health optional		boolean
control_plane_health optional		boolean
service_layer_health optional		boolean

BgpRouterBgpRouterRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		BgpPeeringAttributes

LacpParams

Name	Description	Schema
lacp_enable optional	Enable or disable this option for configuring LACP related params	boolean
lacp_interval optional	Timer interval for periodic transmission of LACP packets. Fast mode receives packets every second. Slow mode receives packets every 30 seconds.	Any of [‘fast’, ‘slow’]
lacp_mode optional	Configure this mode to active to initiate transmission of LACP packets and respond to LACP packets. LACP packets are not exchanged with passive mode.	Any of [‘active’, ‘passive’]

RoutedProperties

Name	Description	Schema
physical_router_uuid required	Routed properties for particular physical router for this virtual-network.	string
logical_router_uuid required	Routed properties for particular logical router for this virtual-network.	string
routed_interface_ip_address required	IP address of the routed interface from the VN subnet.	string
loopback_ip_address optional	IP address of the loopback interface from the overlay loopback subnet.	string
routing_protocol required	Protocol used for exchanging route information.	Any of [‘static-routes’, ‘bgp’, ‘ospf’, ‘pim’]
bgp_params optional	BGP parameters such as ASN, peer IP address, authentication method/key.	BgpParameters
ospf_params optional	OSPF parameters such as area ID, area type, hello-interval, dead-interval, authentication method/key.	OspfParameters
pim_params optional	PIM parameters such as RP IP address, mode.	PimParameters
static_route_params optional	Static route parameters such as interface route table uuid, next hop IP address.	StaticRouteParameters
bfd_params optional	BFD parameters such as time interval, detection time multiplier.	BfdParameters
routing_policy_params optional	List of import/export routing policy uuids.	RoutingPolicyParameters

FirewallPolicyFirewallRuleRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		FirewallSequence

LogicalRouterVirtualNetworkRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		LogicalRouterVirtualNetworkType

OspfParameters

Name	Description	Schema
auth_data optional	Authentication related configuration like type, keys etc.	AuthenticationData
hello_interval optional	Specifies the length of time, in seconds, before the routing device sends a hello packet out of an interface.	integer
dead_interval optional	Specifies how long OSPF waits before declaring that a neighboring routing device is unavailable	integer
area_id required	OSPF area ID	string
area_type required	OSPF area type	Any of [‘nssa’, ‘stub’, ‘backbone’]
advertise_loopback optional	Boolean to enable advertising loopback address.	boolean
orignate_summary_lsa optional	Boolean to enable originating summary LSA.	boolean

RouteType

Name	Description	Schema
prefix optional	Ip prefix/len format prefix	string
next_hop optional	Ip address or service instance name.	string
next_hop_type optional		Any of [‘service-instance’, ‘ip-address’]
community_attributes optional		CommunityAttributes

VirtualMachineInterfaceVirtualPortGroupRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		VMIVirtualPortGroupAttributes

ServiceScaleOutType

Name	Description	Schema
max_instances required	Maximum number of scale out factor(virtual machines). can be changed dynamically	integer
auto_scale required	Automatically change the number of virtual machines. Not implemented	boolean

PermType2

Name	Description	Schema
owner required	Owner tenant of the object	string
owner_access required	Owner permissions of the object	integer
global_access optional	Globally(others) shared object and permissions for others of the object	integer
share optional	Selectively shared object, List of (tenant, permissions)	ShareType

ExecutableInfoType

Name	Description	Schema
executable_path required	absolute path of the binary to execute	string
executable_args optional	Optional arguments to be passed to the executable	string
job_completion_weightage optional	Job percentage completion when this executable is completed.	integer

SecurityLoggingObjectRuleEntryType

Name	Description	Schema
rule_uuid optional	Rule UUID of network policy or security-group. When this is absent it implies all rules of security-group or network-policy	string
rate optional	Rate at which sessions are logged. When rates are specified at multiple levels, the rate which specifies highest frequency is selected	integer

SecurityLoggingObjectNetworkPolicyRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		SecurityLoggingObjectRuleListType

HostBasedServiceVirtualNetworkRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ServiceVirtualNetworkType

AllowedAddressPair

Name	Description	Schema
ip optional		SubnetType
mac optional		string
address_mode optional	Address-mode active-backup is used for VRRP address. Address-mode active-active is used for ECMP.	Any of [‘active-active’, ‘active-standby’]

IdPermsType

Name	Description	Schema
permissions optional	No longer used, will be removed	PermType
uuid required	UUID of the object, system automatically allocates one if not provided	UuidType
enable required	Administratively Enable/Disable this object	boolean
created optional	Time when this object was created	string
last_modified optional	Time when this object was last modified	string
description optional	User provided text	string
user_visible optional	System created internal objects will have this flag set and will not be visible	boolean
creator optional	Id of tenant who created this object	string

KeyValuePair

Name	Description	Schema
key optional		string
value optional		string

FlowAgingTimeout

Name	Description	Schema
protocol optional		string
port optional		integer
timeout_in_seconds optional		integer

VirtualNetworkNetworkPolicyRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		VirtualNetworkPolicyType

DhcpOptionType

Name	Description	Schema
dhcp_option_name required	Name of the DHCP option	string
dhcp_option_value required	Encoded DHCP option value (decimal)	string
dhcp_option_value_bytes required	Value of the DHCP option to be copied byte by byte	string

PlaybookInfoType

Name	Description	Schema
playbook_uri required	uri to the playbook location on the file server	string
multi_device_playbook optional	if set to true, the execute-job action url uses the job-template parameter ‘device-list’ to execute the playbook in parallel	boolean
vendor optional	Vendor name	string
device_family optional	Device family name	string
job_completion_weightage optional	Job percentage completion when this playbook is completed. This attribute value should 100 if there is only one playbook defined in the job template. The job- completion-weigtages for all playbooks in the same job-template should add up to 100 exact.	integer
sequence_no optional	Sequence number of the playbook	integer

InterfaceMirrorType

Name	Description	Schema
traffic_direction required	Specifies direction of traffic to mirror, Ingress, Egress or both	Any of [‘ingress’, ‘egress’, ‘both’]
mirror_to required	Mirror destination configuration	MirrorActionType

AlarmExpression

Name	Description	Schema
operation required	operation to compare operand1 and operand2	Any of [‘==’, ‘!=’, ‘<’, ‘<=’, ‘>’, ‘>=’, ‘in’, ‘not in’, ‘range’, ‘size==’, ‘size!=’]
operand1 required	UVE attribute specified in the dotted format. Example: NodeStatus.process_info.process_state	string
operand2 required	UVE attribute or a json value to compare with the UVE attribute in operand1	AlarmOperand2
variables optional	List of UVE attributes that would be useful when the alarm is raised. For example, user may want to raise an alarm if the NodeStatus.process_info.process_state != PROCESS_STATE_RUNNING. But, it would be useful to know the process_name whose state != PROCESS_STATE_RUNNING. This UVE attribute which is neither part of operand1 nor operand2 may be specified in variables	string

DnsSoaRecordType

Name	Description	Schema
negative_cache_ttl_seconds optional	Default Time To Live for negative caching of DNS queries	integer

BgpSession

Name	Description	Schema
uuid required	When multiple sessions are present, each session must have an unique id.	string
attributes required	There can be upto 3 instances BGP session attributes, representing configuration for both ends and common. Currently only 1 instance representing common attributes is supported.	BgpSessionAttributes

BgpAsAServiceControlNodeZoneRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		BGPaaSControlNodeZoneAttributes

BaremetalProperties

Name	Description	Schema
memory_mb optional	RAM of the Baremetal server (in MB)	integer
cpu_arch optional	Architecture of the baremetal server	string
local_gb optional	Disk size of root device (in GB)	integer
cpus optional	Number of CPU cores on the baremetal	integer
capabilities optional	Boot option	string

PortGroupProperties

Name	Description	Schema
miimon optional	Specifies the MII link monitoring frequency in milliseconds.	integer
xmit_hash_policy optional	Transmit hash policy to use for slave selection in balance-xor, 802.3ad, and tlb modes.	string

ShareType

Name	Description	Schema
tenant required	Name of tenant with whom the object is shared	string
tenant_access required	Allowed permissions in sharing	integer

DeviceCredential

Name	Description	Schema
credential required		UserCredentials
vendor optional		string
device_family optional		string

RouteOriginOverride

Name	Description	Schema
origin_override optional	Set true to override Route origin with the given value	boolean
origin optional	User define route origin value	Any of [‘IGP’, ‘EGP’, ‘INCOMPLETE’]

TelemetryResourceInfo

Name	Description	Schema
name optional		string
path optional		string
rate optional		string

ResourceReference

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array

MatchConditionType

Name	Description	Schema
protocol required	Layer 4 protocol in ip packet	string
src_address required	Source ip matching criteria	AddressType
src_port required	Range of source port for layer 4 protocol	PortType
dst_address required	Destination ip matching criteria	AddressType
dst_port required	Range of destination port for layer 4 protocol	PortType
ethertype required		Any of [‘IPv4’, ‘IPv6’]

CliDiffInfoType

Name	Description	Schema
username optional		string
time optional		string
config_changes optional		string

RbacRuleType

Name	Description	Schema
rule_object required	Name of the REST API (object) for this rule, * represent all objects	string
rule_field optional	Name of the level one field (property) for this object, * represent all properties	string
rule_perms required	List of [(role, permissions),...]	RbacPermType

TermActionListType

Name	Description	Schema
update optional		ActionUpdateType
action optional		Any of [‘reject’, ‘accept’, ‘next’]
action_next_value optional		Any of [‘term’, ‘policy’]
external optional		Any of [‘ospf-type-1’, ‘ospf-type-2’]
as_path_expand optional	Valid only for network-device TermType. string should be in format of AS number(s) seperated by spaces	string
as_path_prepend optional	Valid only for network-device TermType. string should be in format of AS number(s) seperated by spaces	string

VirtualMachineInterfaceBridgeDomainRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		BridgeDomainMembershipType

IpamSubnetType

Name	Description	Schema
subnet required	ip prefix and length for the subnet	SubnetType
default_gateway optional	default-gateway ip address in the subnet, if not provided one is auto generated by the system.	string
dns_server_address optional	DNS server ip address in the subnet, if not provided one is auto generated by the system.	string
subnet_uuid optional	Subnet UUID is auto generated by the system	string
enable_dhcp optional	Enable DHCP for the VM(s) in this subnet	boolean
dns_nameservers optional	Tenant DNS servers ip address in tenant DNS method	string
allocation_pools optional	List of ranges of ip address within the subnet from which to allocate ip address. default is entire prefix	AllocationPoolType
addr_from_start optional	Start address allocation from start or from end of address range.	boolean
dhcp_option_list optional	DHCP options list to be sent via DHCP for VM(s) in this subnet	DhcpOptionsListType
host_routes optional	Host routes to be sent via DHCP for VM(s) in this subnet, Next hop for these routes is always default gateway	RouteTableType
subnet_name optional	User provided name for this subnet	string
alloc_unit optional	allocation unit for this subnet to allocate bulk ip addresses	integer
created optional	timestamp when subnet object gets created	string
last_modified optional	timestamp when subnet object gets updated	string
subscriber_tag optional	This represents subscribers assigned ip addresses from this subnet for fabric peer network	string
vlan_tag optional	vlan this subnet belongs to	integer
dhcp_relay_server optional	DHCP relay server IP	string

NodeProfileRoleType

Name	Description	Schema
physical_role optional		string
rb_roles optional		string

ProjectNamespaceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		SubnetType

PimParameters

Name	Description	Schema
rp_ip_address required	Static rendezvous point IP address.	string
mode optional	Pim mode.	Any of [‘sparse’, ‘sparse-dense’, ‘dense’]
enable_all_interfaces optional	Boolean to enable PIM on all interfaces.	boolean

BgpFamilyAttributes

Name	Description	Schema
address_family required	Address family for which these parameters are applied.	Any of [‘inet’, ‘inet-labeled’, ‘inet-vpn’, ‘e-vpn’, ‘erm-vpn’, ‘route-target’, ‘inet6’, ‘inet-mvpn’, ‘inet6-vpn’]
loop_count optional	For routing loop detection, loop-count is the number of times the local bgp- routers AS is allowed in the AS_PATH attribute.	integer
prefix_limit optional	prefix-limit contains the maximum number of prefixes that are allowed to be received on the session for this address family.	BgpPrefixLimit
default_tunnel_encap optional	Default prioritized tunnel encapsulation list.	Any of [‘gre’, ‘mpls’, ‘udp’, ‘vxlan’]

VirtualPortGroupPhysicalInterfaceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		VpgInterfaceParametersType

EncryptionTunnelEndpoint

Name	Description	Schema
tunnel_remote_ip_address required	Tunnel endpoint remote address	string

FirewallPolicySecurityLoggingObjectRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		SloRateType

ProtocolBgpType

Name	Description	Schema
autonomous_system optional		integer

ServiceHealthCheckServiceInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ServiceInterfaceTag

DiscoveryPubSubEndPointType

Name	Description	Schema
ep_type required	Type of service or client	string
ep_id optional	Specific service or client which is set of one.	string
ep_prefix optional	All servers or clients whose ip match this prefix	SubnetType
ep_version optional	All servers or clients whose version match this version	string

StructuredSyslogLANSegmentType

Name	Description	Schema
vpn optional		string
network_ranges optional		string

VirtualNetworkNetworkIpamRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		VnSubnetsType

UuidType

Name	Description	Schema
uuid_mslong optional		number
uuid_lslong optional		number

RoutingPolicyServiceInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		RoutingPolicyServiceInstanceType

AuthenticationData

Name	Description	Schema
key_type required	Authentication type for this session. Currently only MD5 is supported.	Any of [‘md5’]
key_items required	Upto two keys can be specified. Currently only one key is supported.	AuthenticationKeyItem

LinklocalServiceEntryType

Name	Description	Schema
linklocal_service_name required	Name of the link local service. VM name resolution of this name will result in link local ip address	string
linklocal_service_ip required	ip address of the link local service.	string
linklocal_service_port required	Destination TCP port number of link local service	integer
ip_fabric_DNS_service_name optional	DNS name to which link local service will be proxied	string
ip_fabric_service_port required	Destination TCP port number to which link local traffic will forwarded	integer
ip_fabric_service_ip optional	Destination ip address to which link local traffic will forwarded	string

InterfaceRouteTableServiceInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ServiceInterfaceTag

RoutingPolicyRoutingInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		RoutingPolicyType

CommunityAttributes

Name	Description	Schema
community_attribute optional	List of Community attributes, it indicates the attributes with which the routes are tagged while publishing. The attributes will be represented as bgp community in the path attribute. Each attribute is indicated as string. 1. String with two integers separated by ‘:’. E.g. ‘64512:123’ 2. Well-known community as string. Possible values are ‘no-export’ ‘accept-own’ ‘no-advertise’ ‘no-export- subconfed’ ‘no-reoriginate’	string

ServiceTemplateInterfaceType

Name	Description	Schema
service_interface_type required	Type of service interface supported by this template left, right or other.	string
shared_ip optional	Shared ip is required on this interface when service instance is scaled out (Only V1)	boolean
static_route_enable optional	Static routes configured required on this interface of service instance (Only V1)	boolean

FirewallRuleSecurityLoggingObjectRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		SloRateType

RouteFilterType

Name	Description	Schema
route_filter_properties optional	List of route filter properties.	RouteFilterProperties

ServiceInstanceInstanceIpRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ServiceInterfaceTag

AuthenticationKeyItem

Name	Description	Schema
key_id optional		integer
key optional		string

MulticastSourceGroup

Name	Description	Schema
source_address required	Multicast Source Address	string
group_address required	Multicast Group Address	string
action required	Pass or deny action for (S,G) matching this rule	Any of [‘deny’, ‘pass’]

RouteAggregateServiceInstanceRefs

Name	Description	Schema
href required		string
uuid required		string
to required	Fully Qualified Name of resource	< string > array
attr optional		ServiceInterfaceTag

RoutingPolicyParameters

Name	Description	Schema
import_routing_policy_uuid optional	list of routing policy uuids used as import policies.	string
export_routing_policy_uuid optional	list of routing policy uuids used as export policies.	string

StaticMirrorNhType

Name	Description	Schema
vtep_dst_ip_address required	ip address of destination vtep	string
vtep_dst_mac_address optional	mac address of destination vtep	string
vni required	Vni of vtep	integer

BfdParameters

Name	Description	Schema
time_interval optional	Rx/Tx time interval for BFD session in milliseconds.	integer
detection_time_multiplier optional	Detection time multiplier for BFD session.	integer

PrefixMatchType

Name	Description	Schema
prefix optional		string
prefix_type optional		Any of [‘exact’, ‘longer’, ‘orlonger’]

BgpParameters

Name	Description	Schema
peer_autonomous_system required	Peer autonomous system number for this eBGP session.	integer
peer_ip_address optional	Peer ip address used for this eBGP session.	string
peer_ip_address_list required	Peer ip address list used for this eBGP session.	string
hold_time optional	BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value 0 will result in default value of 90 seconds	integer
auth_data optional	Authentication related configuration like type, keys etc.	AuthenticationData
local_autonomous_system optional	BgpRouter specific Autonomous System number if different from global AS number.	integer
multihop_ttl optional	time-to-live (TTL) value in the BGP packets to control how far they propagate.	integer

StaticRouteParameters

Name	Description	Schema
interface_route_table_uuid required	list of interface route table uuids used to build list of prefixes.	string
next_hop_ip_address required	List of next-hop IP addresses.	string

AlarmOperand2

Name	Description	Schema
uve_attribute optional	UVE attribute specified in the dotted format. Example: NodeStatus.process_info.process_state	string
json_value optional	json value as string	string

RbacPermType

Name	Description	Schema
role_name required	Name of the role	string
role_crud required	String CRUD representing permissions for C=create, R=read, U=update, D=delete.	string

PrefixListMatchType

Name	Description	Schema
interface_route_table_uuid required	list of interface route table uuids used to build list of prefixes.	string
prefix_type optional		Any of [‘exact’, ‘longer’, ‘orlonger’]

PermType

Name	Description	Schema
owner optional		string
owner_access required	Three bits representing rwx. r=read permission, w=write permission, x=reference permission	integer
group optional		string
group_access required	Three bits representing rwx. r=read permission, w=write permission, x=reference permission	integer
other_access required	Three bits representing rwx. r=read permission, w=write permission, x=reference permission	integer

ActionUpdateType

Name	Description	Schema
as_path optional		ActionAsPathType
community optional		ActionCommunityType
extcommunity optional		ActionExtCommunityType
local_pref optional		integer
med optional		integer

ActionCommunityType

Name	Description	Schema
add optional		CommunityListType
remove optional		CommunityListType
set optional		CommunityListType

BgpPrefixLimit

Name	Description	Schema
maximum optional		integer
idle_timeout optional	Time in seconds after which the session is allowed to re-establish after teardown.	integer

ActionExtCommunityType

Name	Description	Schema
add optional		ExtCommunityListType
remove optional		ExtCommunityListType
set optional		ExtCommunityListType

ExtCommunityListType

Name	Description	Schema
community optional		string

RouteFilterProperties

Name	Description	Schema
route required	route filter IP address or host name.	string
route_type optional		Any of [‘exact’, ‘longer’, ‘orlonger’, ‘prefix-length-range’, ‘through’, ‘upto’]
route_type_value optional	Valid only for through, upto or prefix-length-range RouteFType. Format: for prefix-length-range it stores ‘/min-length-/max-length’. through should be string, upto stores ‘/number’	string

CommunityListType

Name	Description	Schema
community optional	List of Community attributes, it indicates the attributes with which the routes are tagged while publishing. The attributes will be represented as bgp community in the path attribute. Each attribute is indicated as string. 1. String with two integers separated by ‘:’. E.g. ‘64512:123’ 2. Well-known community as string. Possible values are ‘no-export’ ‘accept-own’ ‘no-advertise’ ‘no-export- subconfed’ ‘no-reoriginate’	string

ActionAsPathType

Name	Description	Schema
expand optional		AsListType

AsListType

Name	Description	Schema
asn_list optional		integer