======================================== 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 ========================= .. hlist:: :columns: 3 * :ref:`service-endpoint ` * :ref:`instance-ip ` * :ref:`service-appliance-set ` * :ref:`dsa-rule ` * :ref:`discovery-service-assignment ` * :ref:`floating-ip-pool ` * :ref:`physical-router ` * :ref:`config-root ` * :ref:`service-template ` * :ref:`hardware-inventory ` * :ref:`firewall-policy ` * :ref:`route-table ` * :ref:`provider-attachment ` * :ref:`overlay-role ` * :ref:`config-properties ` * :ref:`network-device-config ` * :ref:`virtual-DNS-record ` * :ref:`control-node-zone ` * :ref:`route-target ` * :ref:`structured-syslog-config ` * :ref:`loadbalancer-listener ` * :ref:`logical-interface ` * :ref:`flow-node ` * :ref:`port-group ` * :ref:`route-aggregate ` * :ref:`logical-router ` * :ref:`domain ` * :ref:`structured-syslog-hostname-record ` * :ref:`routing-policy ` * :ref:`node-profile ` * :ref:`bridge-domain ` * :ref:`alias-ip ` * :ref:`network-policy ` * :ref:`port ` * :ref:`bgp-as-a-service ` * :ref:`subnet ` * :ref:`global-system-config ` * :ref:`sub-cluster ` * :ref:`forwarding-class ` * :ref:`service-group ` * :ref:`global-analytics-config ` * :ref:`address-group ` * :ref:`application-policy-set ` * :ref:`virtual-ip ` * :ref:`intent-map ` * :ref:`analytics-alarm-node ` * :ref:`netconf-profile ` * :ref:`qos-queue ` * :ref:`physical-role ` * :ref:`card ` * :ref:`global-qos-config ` * :ref:`qos-config ` * :ref:`analytics-snmp-node ` * :ref:`virtual-machine-interface ` * :ref:`cli-config ` * :ref:`service-object ` * :ref:`feature-flag ` * :ref:`loadbalancer ` * :ref:`structured-syslog-tenant-record ` * :ref:`peering-policy ` * :ref:`structured-syslog-application-record ` * :ref:`global-vrouter-config ` * :ref:`webui-node ` * :ref:`floating-ip ` * :ref:`link-aggregation-group ` * :ref:`virtual-router ` * :ref:`port-profile ` * :ref:`policy-management ` * :ref:`e2-service-provider ` * :ref:`fabric ` * :ref:`job-template ` * :ref:`service-instance ` * :ref:`role-config ` * :ref:`tag-type ` * :ref:`structured-syslog-message ` * :ref:`loadbalancer-pool ` * :ref:`security-logging-object ` * :ref:`analytics-node ` * :ref:`virtual-DNS ` * :ref:`config-database-node ` * :ref:`config-node ` * :ref:`device-functional-group ` * :ref:`firewall-rule ` * :ref:`bgpvpn ` * :ref:`role-definition ` * :ref:`service-connection-module ` * :ref:`security-group ` * :ref:`database-node ` * :ref:`loadbalancer-healthmonitor ` * :ref:`devicemgr-node ` * :ref:`project ` * :ref:`fabric-namespace ` * :ref:`alarm ` * :ref:`multicast-policy ` * :ref:`device-chassis ` * :ref:`sflow-profile ` * :ref:`hardware ` * :ref:`tag ` * :ref:`feature-config ` * :ref:`telemetry-profile ` * :ref:`bgp-router ` * :ref:`virtual-network ` * :ref:`virtual-port-group ` * :ref:`loadbalancer-member ` * :ref:`namespace ` * :ref:`feature ` * :ref:`storm-control-profile ` * :ref:`device-image ` * :ref:`physical-interface ` * :ref:`snmp-profile ` * :ref:`node ` * :ref:`grpc-profile ` * :ref:`customer-attachment ` * :ref:`structured-syslog-sla-profile ` * :ref:`host-based-service ` * :ref:`virtual-machine ` * :ref:`interface-route-table ` * :ref:`service-appliance ` * :ref:`service-health-check ` * :ref:`network-ipam ` * :ref:`api-access-list ` * :ref:`alias-ip-pool ` * :ref:`data-center-interconnect ` System created object types =========================== .. hlist:: :columns: 3 * :ref:`routing-instance ` * :ref:`access-control-list ` * :ref:`port-tuple ` Type specific REST API and data model ====================================== .. _access-control-list-label: 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*: :ref:`virtual-network `, :ref:`security-group ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" access-control-list-entries, "Automatically generated by system based on security groups or network policies.", False, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AccessControlListReadAll`_ **404**, "Not Found", `Error`_ **Update a specific access-control-list** PUT /access-control-list/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **access-control-list** *optional*, "", `AccessControlListUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific access-control-list** DELETE /access-control-list/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new access-control-list** POST /access-control-lists *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **access-control-list** *required*, "Body of access-control-list resource", `AccessControlListCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _address-group-label: address-group ------------- Data Model ^^^^^^^^^^ *Description* When parent is policy-management, Address Group object When parent is project, Project level address Group object *Parents*: :ref:`policy-management `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" draft-mode-state, "None", False, string, R, user address-group-prefix, "List of IP prefix", False, :ref:`SubnetListType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AddressGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific address-group** PUT /address-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **address-group** *optional*, "", `AddressGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific address-group** DELETE /address-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of address-group** GET /address-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new address-group** POST /address-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **address-group** *required*, "Body of address-group resource", `AddressGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _alarm-label: 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*: :ref:`global-system-config `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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:, etc.,", True, :ref:`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, :ref:`AlarmOrList `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AlarmReadAll`_ **404**, "Not Found", `Error`_ **Update a specific alarm** PUT /alarm/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **alarm** *optional*, "", `AlarmUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific alarm** DELETE /alarm/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of alarm** GET /alarms *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new alarm** POST /alarms *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **alarm** *required*, "Body of alarm resource", `AlarmCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific analytics-alarm-node** GET /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsAlarmNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-alarm-node** PUT /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-alarm-node** *optional*, "", `AnalyticsAlarmNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-alarm-node** DELETE /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-alarm-node** POST /analytics-alarm-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-alarm-node** *required*, "Body of analytics-alarm-node resource", `AnalyticsAlarmNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _alias-ip-label: 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*: :ref:`alias-ip-pool ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AliasIpReadAll`_ **404**, "Not Found", `Error`_ **Update a specific alias-ip** PUT /alias-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **alias-ip** *optional*, "", `AliasIpUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific alias-ip** DELETE /alias-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of alias-ip** GET /alias-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new alias-ip** POST /alias-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **alias-ip** *required*, "Body of alias-ip resource", `AliasIpCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific alias-ip-pool** GET /alias-ip-pool/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AliasIpPoolReadAll`_ **404**, "Not Found", `Error`_ **Update a specific alias-ip-pool** PUT /alias-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **alias-ip-pool** *optional*, "", `AliasIpPoolUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific alias-ip-pool** DELETE /alias-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new alias-ip-pool** POST /alias-ip-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **alias-ip-pool** *required*, "Body of alias-ip-pool resource", `AliasIpPoolCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _alias-ip-pool-label: 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*: :ref:`virtual-network ` *Children* :ref:`alias-ip ` *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AliasIpPoolReadAll`_ **404**, "Not Found", `Error`_ **Update a specific alias-ip-pool** PUT /alias-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **alias-ip-pool** *optional*, "", `AliasIpPoolUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific alias-ip-pool** DELETE /alias-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new alias-ip-pool** POST /alias-ip-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **alias-ip-pool** *required*, "Body of alias-ip-pool resource", `AliasIpPoolCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _analytics-alarm-node-label: analytics-alarm-node -------------------- Data Model ^^^^^^^^^^ *Description* Analytics node is object representing a logical node in system which serves operational API and analytics collector. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsAlarmNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-alarm-node** PUT /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-alarm-node** *optional*, "", `AnalyticsAlarmNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-alarm-node** DELETE /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-alarm-node** POST /analytics-alarm-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-alarm-node** *required*, "Body of analytics-alarm-node resource", `AnalyticsAlarmNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _analytics-node-label: analytics-node -------------- Data Model ^^^^^^^^^^ *Description* Analytics node is object representing a logical node in system which serves operational API and analytics collector. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-node** PUT /analytics-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-node** *optional*, "", `AnalyticsNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-node** DELETE /analytics-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of analytics-node** GET /analytics-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-node** POST /analytics-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-node** *required*, "Body of analytics-node resource", `AnalyticsNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _analytics-snmp-node-label: analytics-snmp-node ------------------- Data Model ^^^^^^^^^^ *Description* Analytics node is object representing a logical node in system which serves operational API and analytics collector. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsSnmpNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-snmp-node** PUT /analytics-snmp-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-snmp-node** *optional*, "", `AnalyticsSnmpNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-snmp-node** DELETE /analytics-snmp-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-snmp-node** POST /analytics-snmp-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-snmp-node** *required*, "Body of analytics-snmp-node resource", `AnalyticsSnmpNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _api-access-list-label: 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*: :ref:`domain `, :ref:`project `, :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`RbacRuleEntriesType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ApiAccessListReadAll`_ **404**, "Not Found", `Error`_ **Update a specific api-access-list** PUT /api-access-list/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **api-access-list** *optional*, "", `ApiAccessListUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific api-access-list** DELETE /api-access-list/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new api-access-list** POST /api-access-lists *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **api-access-list** *required*, "Body of api-access-list resource", `ApiAccessListCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _application-policy-set-label: 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*: :ref:`policy-management `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ApplicationPolicySetReadAll`_ **404**, "Not Found", `Error`_ **Update a specific application-policy-set** PUT /application-policy-set/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **application-policy-set** *optional*, "", `ApplicationPolicySetUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific application-policy-set** DELETE /application-policy-set/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new application-policy-set** POST /application-policy-sets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **application-policy-set** *required*, "Body of application-policy-set resource", `ApplicationPolicySetCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _bgp-as-a-service-label: 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*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **bgp-as-a-service** *optional*, "", `BgpAsAServiceUpdate`_, *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new bgp-as-a-service** POST /bgp-as-a-services *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **bgp-as-a-service** *required*, "Body of bgp-as-a-service resource", `BgpAsAServiceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _bgp-router-label: bgp-router ---------- Data Model ^^^^^^^^^^ *Description* *Parents*: :ref:`routing-instance ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" bgp-router-parameters, "BGP router configuration parameters like ip address, AS number, hold time etc.", True, :ref:`BgpRouterParams `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `BgpRouterReadAll`_ **404**, "Not Found", `Error`_ **Update a specific bgp-router** PUT /bgp-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **bgp-router** *optional*, "", `BgpRouterUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific bgp-router** DELETE /bgp-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of bgp-router** GET /bgp-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new bgp-router** POST /bgp-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **bgp-router** *required*, "Body of bgp-router resource", `BgpRouterCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _bgpvpn-label: bgpvpn ------ Data Model ^^^^^^^^^^ *Description* BGP VPN resource contains a set of parameters for a BGP-based VPN *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`RouteTargetList `, CRUD, user import-route-target-list, "List of route targets that are used as import for this virtual network.", False, :ref:`RouteTargetList `, CRUD, user export-route-target-list, "List of route targets that are used as export for this virtual network.", False, :ref:`RouteTargetList `, CRUD, user bgpvpn-type, "BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3).", True, string, CR, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `BgpvpnReadAll`_ **404**, "Not Found", `Error`_ **Update a specific bgpvpn** PUT /bgpvpn/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **bgpvpn** *optional*, "", `BgpvpnUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific bgpvpn** DELETE /bgpvpn/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of bgpvpn** GET /bgpvpns *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new bgpvpn** POST /bgpvpns *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **bgpvpn** *required*, "Body of bgpvpn resource", `BgpvpnCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _bridge-domain-label: bridge-domain ------------- Data Model ^^^^^^^^^^ *Description* bridge-domains configured in a virtual network *Parents*: :ref:`virtual-network ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`MACLimitControlType `, CRUD, user mac-move-control, "MAC move control on the network", False, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `BridgeDomainReadAll`_ **404**, "Not Found", `Error`_ **Update a specific bridge-domain** PUT /bridge-domain/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **bridge-domain** *optional*, "", `BridgeDomainUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific bridge-domain** DELETE /bridge-domain/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of bridge-domain** GET /bridge-domains *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new bridge-domain** POST /bridge-domains *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **bridge-domain** *required*, "Body of bridge-domain resource", `BridgeDomainCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _card-label: card ---- Data Model ^^^^^^^^^^ *Description* This resource contains the information about the interface card in a hardware platform. *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" interface-map, "Interface map of all the physical ports on a physical interface card.", True, :ref:`InterfaceMapType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `CardReadAll`_ **404**, "Not Found", `Error`_ **Update a specific card** PUT /card/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **card** *optional*, "", `CardUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific card** DELETE /card/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of card** GET /cards *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new card** POST /cards *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **card** *required*, "Body of card resource", `CardCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _cli-config-label: cli-config ---------- Data Model ^^^^^^^^^^ *Description* CLI commits done on a physical router. *Parents*: :ref:`physical-router ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`CliDiffListType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `CliConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific cli-config** PUT /cli-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **cli-config** *optional*, "", `CliConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific cli-config** DELETE /cli-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of cli-config** GET /cli-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new cli-config** POST /cli-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **cli-config** *required*, "Body of cli-config resource", `CliConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _config-database-node-label: 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*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigDatabaseNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-database-node** PUT /config-database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-database-node** *optional*, "", `ConfigDatabaseNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-database-node** DELETE /config-database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-database-node** POST /config-database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-database-node** *required*, "Body of config-database-node resource", `ConfigDatabaseNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _config-node-label: config-node ----------- Data Model ^^^^^^^^^^ *Description* Config node is object representing a logical node in system which serves config API. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-node** PUT /config-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-node** *optional*, "", `ConfigNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-node** DELETE /config-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of config-node** GET /config-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-node** POST /config-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-node** *required*, "Body of config-node resource", `ConfigNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _config-properties-label: config-properties ----------------- Data Model ^^^^^^^^^^ *Description* List of config properties. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" properties, "List of Config properties", False, :ref:`KeyValuePairs `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigPropertiesReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-properties** PUT /config-properties/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-properties** *optional*, "", `ConfigPropertiesUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-properties** DELETE /config-properties/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of config-properties** GET /config-propertiess *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-properties** POST /config-propertiess *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-properties** *required*, "Body of config-properties resource", `ConfigPropertiesCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _config-root-label: config-root ----------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigRootReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-root** PUT /config-root/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-root** *optional*, "", `ConfigRootUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-root** DELETE /config-root/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of config-root** GET /config-roots *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-root** POST /config-roots *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-root** *required*, "Body of config-root resource", `ConfigRootCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _control-node-zone-label: control-node-zone ----------------- Data Model ^^^^^^^^^^ *Description* List of references to all control-node-zones in systems. *Parents*: :ref:`global-system-config ` *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ControlNodeZoneReadAll`_ **404**, "Not Found", `Error`_ **Update a specific control-node-zone** PUT /control-node-zone/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **control-node-zone** *optional*, "", `ControlNodeZoneUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific control-node-zone** DELETE /control-node-zone/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new control-node-zone** POST /control-node-zones *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **control-node-zone** *required*, "Body of control-node-zone resource", `ControlNodeZoneCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _customer-attachment-label: customer-attachment ------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" attachment-address, "None", False, :ref:`AttachmentAddressType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `CustomerAttachmentReadAll`_ **404**, "Not Found", `Error`_ **Update a specific customer-attachment** PUT /customer-attachment/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **customer-attachment** *optional*, "", `CustomerAttachmentUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific customer-attachment** DELETE /customer-attachment/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of customer-attachment** GET /customer-attachments *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new customer-attachment** POST /customer-attachments *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **customer-attachment** *required*, "Body of customer-attachment resource", `CustomerAttachmentCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _data-center-interconnect-label: 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*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`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, :ref:`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, :ref:`LogicalRouterPRListType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DataCenterInterconnectReadAll`_ **404**, "Not Found", `Error`_ **Update a specific data-center-interconnect** PUT /data-center-interconnect/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **data-center-interconnect** *optional*, "", `DataCenterInterconnectUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific data-center-interconnect** DELETE /data-center-interconnect/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new data-center-interconnect** POST /data-center-interconnects *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **data-center-interconnect** *required*, "Body of data-center-interconnect resource", `DataCenterInterconnectCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _database-node-label: database-node ------------- Data Model ^^^^^^^^^^ *Description* Database node is object representing a logical node in system which host Cassandra DB and Zookeeper. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigDatabaseNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-database-node** PUT /config-database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-database-node** *optional*, "", `ConfigDatabaseNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-database-node** DELETE /config-database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-database-node** POST /config-database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-database-node** *required*, "Body of config-database-node resource", `ConfigDatabaseNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific database-node** GET /database-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DatabaseNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific database-node** PUT /database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **database-node** *optional*, "", `DatabaseNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific database-node** DELETE /database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of database-node** GET /database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new database-node** POST /database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **database-node** *required*, "Body of database-node resource", `DatabaseNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _device-chassis-label: 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* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" device-chassis-type, "type of the chassis address if known.", False, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DeviceChassisReadAll`_ **404**, "Not Found", `Error`_ **Update a specific device-chassis** PUT /device-chassis/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **device-chassis** *optional*, "", `DeviceChassisUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific device-chassis** DELETE /device-chassis/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of device-chassis** GET /device-chassiss *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new device-chassis** POST /device-chassiss *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **device-chassis** *required*, "Body of device-chassis resource", `DeviceChassisCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _device-functional-group-label: 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* .. csv-table:: :header: "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, :ref:`RoutingBridgingRolesType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DeviceFunctionalGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific device-functional-group** PUT /device-functional-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **device-functional-group** *optional*, "", `DeviceFunctionalGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific device-functional-group** DELETE /device-functional-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new device-functional-group** POST /device-functional-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **device-functional-group** *required*, "Body of device-functional-group resource", `DeviceFunctionalGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _device-image-label: device-image ------------ Data Model ^^^^^^^^^^ *Description* list of device image info for the images that get uploaded to the system. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DeviceImageReadAll`_ **404**, "Not Found", `Error`_ **Update a specific device-image** PUT /device-image/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **device-image** *optional*, "", `DeviceImageUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific device-image** DELETE /device-image/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of device-image** GET /device-images *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new device-image** POST /device-images *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **device-image** *required*, "Body of device-image resource", `DeviceImageCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _devicemgr-node-label: devicemgr-node -------------- Data Model ^^^^^^^^^^ *Description* devicemgr node is object representing a logical node in system for configuring physical devices. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DevicemgrNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific devicemgr-node** PUT /devicemgr-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **devicemgr-node** *optional*, "", `DevicemgrNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific devicemgr-node** DELETE /devicemgr-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of devicemgr-node** GET /devicemgr-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new devicemgr-node** POST /devicemgr-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **devicemgr-node** *required*, "Body of devicemgr-node resource", `DevicemgrNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _discovery-service-assignment-label: discovery-service-assignment ---------------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* :ref:`dsa-rule ` *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DiscoveryServiceAssignmentReadAll`_ **404**, "Not Found", `Error`_ **Update a specific discovery-service-assignment** PUT /discovery-service-assignment/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **discovery-service-assignment** *optional*, "", `DiscoveryServiceAssignmentUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific discovery-service-assignment** DELETE /discovery-service-assignment/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new discovery-service-assignment** POST /discovery-service-assignments *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **discovery-service-assignment** *required*, "Body of discovery-service-assignment resource", `DiscoveryServiceAssignmentCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _domain-label: domain ------ Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* :ref:`api-access-list `, :ref:`namespace `, :ref:`project `, :ref:`service-template `, :ref:`virtual-DNS ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" domain-limits, "Domain level quota, not currently implemented", False, :ref:`DomainLimitsType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `BridgeDomainReadAll`_ **404**, "Not Found", `Error`_ **Update a specific bridge-domain** PUT /bridge-domain/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **bridge-domain** *optional*, "", `BridgeDomainUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific bridge-domain** DELETE /bridge-domain/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of bridge-domain** GET /bridge-domains *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new bridge-domain** POST /bridge-domains *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **bridge-domain** *required*, "Body of bridge-domain resource", `BridgeDomainCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific domain** GET /domain/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DomainReadAll`_ **404**, "Not Found", `Error`_ **Update a specific domain** PUT /domain/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **domain** *optional*, "", `DomainUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific domain** DELETE /domain/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of domain** GET /domains *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new domain** POST /domains *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **domain** *required*, "Body of domain resource", `DomainCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _dsa-rule-label: dsa-rule -------- Data Model ^^^^^^^^^^ *Description* Discovery service rule for assigning subscriber to publisher. (set of subscriber) can be assigned to (set of publisher). *Parents*: :ref:`discovery-service-assignment ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" dsa-rule-entry, "rule entry defining publisher set and subscriber set.", True, :ref:`DiscoveryServiceAssignmentType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DsaRuleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific dsa-rule** PUT /dsa-rule/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **dsa-rule** *optional*, "", `DsaRuleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific dsa-rule** DELETE /dsa-rule/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of dsa-rule** GET /dsa-rules *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new dsa-rule** POST /dsa-rules *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **dsa-rule** *required*, "Body of dsa-rule resource", `DsaRuleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _e2-service-provider-label: e2-service-provider ------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `E2ServiceProviderReadAll`_ **404**, "Not Found", `Error`_ **Update a specific e2-service-provider** PUT /e2-service-provider/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **e2-service-provider** *optional*, "", `E2ServiceProviderUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific e2-service-provider** DELETE /e2-service-provider/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new e2-service-provider** POST /e2-service-providers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **e2-service-provider** *required*, "Body of e2-service-provider resource", `E2ServiceProviderCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _fabric-label: 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*: :ref:`global-system-config ` *Children* :ref:`fabric-namespace `, :ref:`virtual-port-group ` *Properties* .. csv-table:: :header: "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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FabricReadAll`_ **404**, "Not Found", `Error`_ **Update a specific fabric** PUT /fabric/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **fabric** *optional*, "", `FabricUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific fabric** DELETE /fabric/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of fabric** GET /fabrics *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new fabric** POST /fabrics *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **fabric** *required*, "Body of fabric resource", `FabricCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific fabric-namespace** GET /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FabricNamespaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific fabric-namespace** PUT /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **fabric-namespace** *optional*, "", `FabricNamespaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific fabric-namespace** DELETE /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of fabric-namespace** GET /fabric-namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new fabric-namespace** POST /fabric-namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **fabric-namespace** *required*, "Body of fabric-namespace resource", `FabricNamespaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _fabric-namespace-label: 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*: :ref:`fabric ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`NamespaceValue `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FabricNamespaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific fabric-namespace** PUT /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **fabric-namespace** *optional*, "", `FabricNamespaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific fabric-namespace** DELETE /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of fabric-namespace** GET /fabric-namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new fabric-namespace** POST /fabric-namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **fabric-namespace** *required*, "Body of fabric-namespace resource", `FabricNamespaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _feature-label: feature ------- Data Model ^^^^^^^^^^ *Description* A granual networking feature supported by Fabric Manager *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FeatureReadAll`_ **404**, "Not Found", `Error`_ **Update a specific feature** PUT /feature/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **feature** *optional*, "", `FeatureUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific feature** DELETE /feature/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of feature** GET /features *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new feature** POST /features *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **feature** *required*, "Body of feature resource", `FeatureCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific feature-config** GET /feature-config/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FeatureConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific feature-config** PUT /feature-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **feature-config** *optional*, "", `FeatureConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific feature-config** DELETE /feature-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of feature-config** GET /feature-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new feature-config** POST /feature-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **feature-config** *required*, "Body of feature-config resource", `FeatureConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific feature-flag** GET /feature-flag/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FeatureFlagReadAll`_ **404**, "Not Found", `Error`_ **Update a specific feature-flag** PUT /feature-flag/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **feature-flag** *optional*, "", `FeatureFlagUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific feature-flag** DELETE /feature-flag/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of feature-flag** GET /feature-flags *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new feature-flag** POST /feature-flags *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **feature-flag** *required*, "Body of feature-flag resource", `FeatureFlagCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _feature-config-label: feature-config -------------- Data Model ^^^^^^^^^^ *Description* Vendor specific and/or feature specific configuration parameters editable by the user *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" feature-config-additional-params, "Additional configuration parameters for the feature.", False, :ref:`KeyValuePairs `, CRUD, user feature-config-vendor-config, "Vendor specific configuration/parameters for the feature.", False, :ref:`KeyValuePairs `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FeatureConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific feature-config** PUT /feature-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **feature-config** *optional*, "", `FeatureConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific feature-config** DELETE /feature-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of feature-config** GET /feature-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new feature-config** POST /feature-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **feature-config** *required*, "Body of feature-config resource", `FeatureConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _feature-flag-label: feature-flag ------------ Data Model ^^^^^^^^^^ *Description* Feature Flag to swtich on/off the allowed feature *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FeatureFlagReadAll`_ **404**, "Not Found", `Error`_ **Update a specific feature-flag** PUT /feature-flag/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **feature-flag** *optional*, "", `FeatureFlagUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific feature-flag** DELETE /feature-flag/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of feature-flag** GET /feature-flags *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new feature-flag** POST /feature-flags *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **feature-flag** *required*, "Body of feature-flag resource", `FeatureFlagCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _firewall-policy-label: 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*: :ref:`policy-management `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" draft-mode-state, "None", False, string, R, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FirewallPolicyReadAll`_ **404**, "Not Found", `Error`_ **Update a specific firewall-policy** PUT /firewall-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **firewall-policy** *optional*, "", `FirewallPolicyUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific firewall-policy** DELETE /firewall-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of firewall-policy** GET /firewall-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new firewall-policy** POST /firewall-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **firewall-policy** *required*, "Body of firewall-policy resource", `FirewallPolicyCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _firewall-rule-label: firewall-rule ------------- Data Model ^^^^^^^^^^ *Description* When parent is policy-management, Firewall-rule object When parent is project, Project level firewall-rule object *Parents*: :ref:`policy-management `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`ActionListType `, CRUD, user service, "Service (port, protocol) for packets match condition", False, :ref:`FirewallServiceType `, CRUD, user endpoint-1, "match condition for traffic source", True, :ref:`FirewallRuleEndpointType `, CRUD, user endpoint-2, "match condition for traffic destination", True, :ref:`FirewallRuleEndpointType `, CRUD, user match-tags, "matching tags for source and destination endpoints", True, :ref:`FirewallRuleMatchTagsType `, CRUD, user match-tag-types, "matching tags ids for source and destination endpoints", True, :ref:`FirewallRuleMatchTagsTypeIdList `, R, user direction, "Direction in the rule", True, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FirewallRuleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific firewall-rule** PUT /firewall-rule/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **firewall-rule** *optional*, "", `FirewallRuleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific firewall-rule** DELETE /firewall-rule/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of firewall-rule** GET /firewall-rules *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new firewall-rule** POST /firewall-rules *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **firewall-rule** *required*, "Body of firewall-rule resource", `FirewallRuleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _floating-ip-label: 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*: :ref:`floating-ip-pool `, :ref:`instance-ip ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`PortMappings `, CRUD, user floating-ip-traffic-direction, "Specifies direction of traffic for the floating-ip", False, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FloatingIpReadAll`_ **404**, "Not Found", `Error`_ **Update a specific floating-ip** PUT /floating-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **floating-ip** *optional*, "", `FloatingIpUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific floating-ip** DELETE /floating-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of floating-ip** GET /floating-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new floating-ip** POST /floating-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **floating-ip** *required*, "Body of floating-ip resource", `FloatingIpCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific floating-ip-pool** GET /floating-ip-pool/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FloatingIpPoolReadAll`_ **404**, "Not Found", `Error`_ **Update a specific floating-ip-pool** PUT /floating-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **floating-ip-pool** *optional*, "", `FloatingIpPoolUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific floating-ip-pool** DELETE /floating-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new floating-ip-pool** POST /floating-ip-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **floating-ip-pool** *required*, "Body of floating-ip-pool resource", `FloatingIpPoolCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _floating-ip-pool-label: 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*: :ref:`virtual-network ` *Children* :ref:`floating-ip ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" floating-ip-pool-subnets, "Subnets that restrict floating ip allocation from the corresponding virtual network.", False, :ref:`FloatingIpPoolSubnetType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FloatingIpPoolReadAll`_ **404**, "Not Found", `Error`_ **Update a specific floating-ip-pool** PUT /floating-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **floating-ip-pool** *optional*, "", `FloatingIpPoolUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific floating-ip-pool** DELETE /floating-ip-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new floating-ip-pool** POST /floating-ip-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **floating-ip-pool** *required*, "Body of floating-ip-pool resource", `FloatingIpPoolCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _flow-node-label: flow-node --------- Data Model ^^^^^^^^^^ *Description* Appformix flows node is object representing a logical node in system which serves xflow collectors. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FlowNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific flow-node** PUT /flow-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **flow-node** *optional*, "", `FlowNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific flow-node** DELETE /flow-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of flow-node** GET /flow-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new flow-node** POST /flow-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **flow-node** *required*, "Body of flow-node resource", `FlowNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _forwarding-class-label: forwarding-class ---------------- Data Model ^^^^^^^^^^ *Description* Link to global-qos config. *Parents*: :ref:`global-qos-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ForwardingClassReadAll`_ **404**, "Not Found", `Error`_ **Update a specific forwarding-class** PUT /forwarding-class/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **forwarding-class** *optional*, "", `ForwardingClassUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific forwarding-class** DELETE /forwarding-class/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of forwarding-class** GET /forwarding-classs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new forwarding-class** POST /forwarding-classs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **forwarding-class** *required*, "Body of forwarding-class resource", `ForwardingClassCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _global-analytics-config-label: global-analytics-config ----------------------- Data Model ^^^^^^^^^^ *Description* global analytics config related data *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `GlobalAnalyticsConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific global-analytics-config** PUT /global-analytics-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **global-analytics-config** *optional*, "", `GlobalAnalyticsConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific global-analytics-config** DELETE /global-analytics-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new global-analytics-config** POST /global-analytics-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **global-analytics-config** *required*, "Body of global-analytics-config resource", `GlobalAnalyticsConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _global-qos-config-label: global-qos-config ----------------- Data Model ^^^^^^^^^^ *Description* Global QoS system config is object where all global system QoS configuration is present. *Parents*: :ref:`global-system-config ` *Children* :ref:`forwarding-class `, :ref:`qos-config `, :ref:`qos-queue ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" control-traffic-dscp, "DSCP value of IP header for control traffic", True, :ref:`ControlTrafficDscpType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `GlobalQosConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific global-qos-config** PUT /global-qos-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **global-qos-config** *optional*, "", `GlobalQosConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific global-qos-config** DELETE /global-qos-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new global-qos-config** POST /global-qos-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **global-qos-config** *required*, "Body of global-qos-config resource", `GlobalQosConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _global-system-config-label: global-system-config -------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* :ref:`alarm `, :ref:`analytics-alarm-node `, :ref:`analytics-node `, :ref:`analytics-snmp-node `, :ref:`api-access-list `, :ref:`config-database-node `, :ref:`config-node `, :ref:`config-properties `, :ref:`control-node-zone `, :ref:`data-center-interconnect `, :ref:`database-node `, :ref:`device-image `, :ref:`devicemgr-node `, :ref:`fabric `, :ref:`flow-node `, :ref:`global-qos-config `, :ref:`global-vrouter-config `, :ref:`intent-map `, :ref:`job-template `, :ref:`node `, :ref:`physical-router `, :ref:`service-appliance-set `, :ref:`virtual-router `, :ref:`webui-node ` *Properties* .. csv-table:: :header: "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, :ref:`GracefulRestartParametersType `, CRUD, user fast-convergence-parameters, "Fast Convergence parameters.", False, :ref:`FastConvergenceParametersType `, CRUD, user plugin-tuning, "Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.", False, :ref:`PluginProperties `, CRUD, user data-center-interconnect-loopback-namespace, "Used for assigning loopback addresses on interconnect physical devices.", False, :ref:`SubnetListType `, CRUD, user data-center-interconnect-asn-namespace, "Used for assigning asn values on interconnect physical devices.", False, :ref:`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 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, :ref:`SubnetListType `, CRUD, user supported-device-families, "List of all supported physical router device family names. Used by UI to show pick list.", False, :ref:`DeviceFamilyListType `, CRUD, user supported-vendor-hardwares, "List of all supported vendor hardware platforms by the system. Used by UI to show pick list.", False, :ref:`VendorHardwaresType `, CRUD, user bgpaas-parameters, "BGP As A Service Parameters configuration", False, :ref:`BGPaaServiceParametersType `, CRUD, user mac-limit-control, "MAC limit control on the network", False, :ref:`MACLimitControlType `, CRUD, user mac-move-control, "MAC move control on the network", False, :ref:`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, :ref:`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, :ref:`KeyValuePairs `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `GlobalSystemConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific global-system-config** PUT /global-system-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **global-system-config** *optional*, "", `GlobalSystemConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific global-system-config** DELETE /global-system-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new global-system-config** POST /global-system-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **global-system-config** *required*, "Body of global-system-config resource", `GlobalSystemConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _global-vrouter-config-label: global-vrouter-config --------------------- Data Model ^^^^^^^^^^ *Description* Global vrouter config is object where all global vrouter config is present. *Parents*: :ref:`global-system-config ` *Children* :ref:`security-logging-object ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" ecmp-hashing-include-fields, "ECMP hashing config at global level.", False, :ref:`EcmpHashingIncludeFields `, CRUD, user linklocal-services, "Global services provided on link local subnet to the virtual machines.", False, :ref:`LinklocalServicesTypes `, CRUD, user encapsulation-priorities, "Ordered list of encapsulations that vrouter will use in priority order.", False, :ref:`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, :ref:`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, :ref:`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, :ref:`PortTranslationPools `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `GlobalVrouterConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific global-vrouter-config** PUT /global-vrouter-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **global-vrouter-config** *optional*, "", `GlobalVrouterConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific global-vrouter-config** DELETE /global-vrouter-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new global-vrouter-config** POST /global-vrouter-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **global-vrouter-config** *required*, "Body of global-vrouter-config resource", `GlobalVrouterConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _grpc-profile-label: grpc-profile ------------ Data Model ^^^^^^^^^^ *Description* This resource contains information specific to grpc parameters *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`GrpcParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `GrpcProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific grpc-profile** PUT /grpc-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **grpc-profile** *optional*, "", `GrpcProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific grpc-profile** DELETE /grpc-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of grpc-profile** GET /grpc-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new grpc-profile** POST /grpc-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **grpc-profile** *required*, "Body of grpc-profile resource", `GrpcProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _hardware-label: 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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `HardwareReadAll`_ **404**, "Not Found", `Error`_ **Update a specific hardware** PUT /hardware/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **hardware** *optional*, "", `HardwareUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific hardware** DELETE /hardware/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of hardware** GET /hardwares *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new hardware** POST /hardwares *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **hardware** *required*, "Body of hardware resource", `HardwareCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific hardware-inventory** GET /hardware-inventory/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `HardwareInventoryReadAll`_ **404**, "Not Found", `Error`_ **Update a specific hardware-inventory** PUT /hardware-inventory/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **hardware-inventory** *optional*, "", `HardwareInventoryUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific hardware-inventory** DELETE /hardware-inventory/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of hardware-inventory** GET /hardware-inventorys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new hardware-inventory** POST /hardware-inventorys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **hardware-inventory** *required*, "Body of hardware-inventory resource", `HardwareInventoryCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _hardware-inventory-label: hardware-inventory ------------------ Data Model ^^^^^^^^^^ *Description* Hardware Inventory on a physical router. *Parents*: :ref:`physical-router ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `HardwareInventoryReadAll`_ **404**, "Not Found", `Error`_ **Update a specific hardware-inventory** PUT /hardware-inventory/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **hardware-inventory** *optional*, "", `HardwareInventoryUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific hardware-inventory** DELETE /hardware-inventory/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of hardware-inventory** GET /hardware-inventorys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new hardware-inventory** POST /hardware-inventorys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **hardware-inventory** *required*, "Body of hardware-inventory resource", `HardwareInventoryCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _host-based-service-label: host-based-service ------------------ Data Model ^^^^^^^^^^ *Description* Project level host based service. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `HostBasedServiceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific host-based-service** PUT /host-based-service/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **host-based-service** *optional*, "", `HostBasedServiceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific host-based-service** DELETE /host-based-service/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new host-based-service** POST /host-based-services *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **host-based-service** *required*, "Body of host-based-service resource", `HostBasedServiceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _instance-ip-label: instance-ip ----------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* :ref:`floating-ip ` *Properties* .. csv-table:: :header: "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, :ref:`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, :ref:`SubnetType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `InstanceIpReadAll`_ **404**, "Not Found", `Error`_ **Update a specific instance-ip** PUT /instance-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **instance-ip** *optional*, "", `InstanceIpUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific instance-ip** DELETE /instance-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of instance-ip** GET /instance-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new instance-ip** POST /instance-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **instance-ip** *required*, "Body of instance-ip resource", `InstanceIpCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _intent-map-label: intent-map ---------- Data Model ^^^^^^^^^^ *Description* List of intent-maps in the system. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `IntentMapReadAll`_ **404**, "Not Found", `Error`_ **Update a specific intent-map** PUT /intent-map/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **intent-map** *optional*, "", `IntentMapUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific intent-map** DELETE /intent-map/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of intent-map** GET /intent-maps *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new intent-map** POST /intent-maps *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **intent-map** *required*, "Body of intent-map resource", `IntentMapCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _interface-route-table-label: interface-route-table --------------------- Data Model ^^^^^^^^^^ *Description* Interface route table is mechanism to add static routes pointing to this interface. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`RouteTableType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `InterfaceRouteTableReadAll`_ **404**, "Not Found", `Error`_ **Update a specific interface-route-table** PUT /interface-route-table/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **interface-route-table** *optional*, "", `InterfaceRouteTableUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific interface-route-table** DELETE /interface-route-table/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new interface-route-table** POST /interface-route-tables *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **interface-route-table** *required*, "Body of interface-route-table resource", `InterfaceRouteTableCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _job-template-label: job-template ------------ Data Model ^^^^^^^^^^ *Description* List of job templates supported by the system. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`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, :ref:`PlaybookInfoListType `, CRUD, user job-template-executables, "List of Executables that needs to be Executed", False, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `JobTemplateReadAll`_ **404**, "Not Found", `Error`_ **Update a specific job-template** PUT /job-template/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **job-template** *optional*, "", `JobTemplateUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific job-template** DELETE /job-template/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of job-template** GET /job-templates *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new job-template** POST /job-templates *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **job-template** *required*, "Body of job-template resource", `JobTemplateCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _link-aggregation-group-label: link-aggregation-group ---------------------- Data Model ^^^^^^^^^^ *Description* List of link aggregation groups on this PRouter. *Parents*: :ref:`physical-router ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LinkAggregationGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific link-aggregation-group** PUT /link-aggregation-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **link-aggregation-group** *optional*, "", `LinkAggregationGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific link-aggregation-group** DELETE /link-aggregation-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new link-aggregation-group** POST /link-aggregation-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **link-aggregation-group** *required*, "Body of link-aggregation-group resource", `LinkAggregationGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _loadbalancer-label: loadbalancer ------------ Data Model ^^^^^^^^^^ *Description* Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners, pools). Applicable to LBaaS V2. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" loadbalancer-properties, "Loadbalancer configuration like admin state, VIP, VIP subnet etc.", True, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer** PUT /loadbalancer/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer** *optional*, "", `LoadbalancerUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer** DELETE /loadbalancer/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer** GET /loadbalancers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer** POST /loadbalancers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer** *required*, "Body of loadbalancer resource", `LoadbalancerCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific loadbalancer-healthmonitor** GET /loadbalancer-healthmonitor/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerHealthmonitorReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-healthmonitor** PUT /loadbalancer-healthmonitor/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-healthmonitor** *optional*, "", `LoadbalancerHealthmonitorUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-healthmonitor** DELETE /loadbalancer-healthmonitor/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-healthmonitor** GET /loadbalancer-healthmonitors *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-healthmonitor** POST /loadbalancer-healthmonitors *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-healthmonitor** *required*, "Body of loadbalancer-healthmonitor resource", `LoadbalancerHealthmonitorCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific loadbalancer-listener** GET /loadbalancer-listener/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerListenerReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-listener** PUT /loadbalancer-listener/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-listener** *optional*, "", `LoadbalancerListenerUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-listener** DELETE /loadbalancer-listener/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-listener** GET /loadbalancer-listeners *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-listener** POST /loadbalancer-listeners *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-listener** *required*, "Body of loadbalancer-listener resource", `LoadbalancerListenerCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific loadbalancer-member** GET /loadbalancer-member/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerMemberReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-member** PUT /loadbalancer-member/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-member** *optional*, "", `LoadbalancerMemberUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-member** DELETE /loadbalancer-member/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-member** GET /loadbalancer-members *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-member** POST /loadbalancer-members *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-member** *required*, "Body of loadbalancer-member resource", `LoadbalancerMemberCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific loadbalancer-pool** GET /loadbalancer-pool/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerPoolReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-pool** PUT /loadbalancer-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-pool** *optional*, "", `LoadbalancerPoolUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-pool** DELETE /loadbalancer-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-pool** GET /loadbalancer-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-pool** POST /loadbalancer-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-pool** *required*, "Body of loadbalancer-pool resource", `LoadbalancerPoolCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _loadbalancer-healthmonitor-label: loadbalancer-healthmonitor -------------------------- Data Model ^^^^^^^^^^ *Description* Health monitor objects is configuration to monitor health of individual pool members. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" loadbalancer-healthmonitor-properties, "Configuration parameters for health monitor like type, method, retries etc.", True, :ref:`LoadbalancerHealthmonitorType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerHealthmonitorReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-healthmonitor** PUT /loadbalancer-healthmonitor/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-healthmonitor** *optional*, "", `LoadbalancerHealthmonitorUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-healthmonitor** DELETE /loadbalancer-healthmonitor/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-healthmonitor** GET /loadbalancer-healthmonitors *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-healthmonitor** POST /loadbalancer-healthmonitors *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-healthmonitor** *required*, "Body of loadbalancer-healthmonitor resource", `LoadbalancerHealthmonitorCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _loadbalancer-listener-label: loadbalancer-listener --------------------- Data Model ^^^^^^^^^^ *Description* Listener represents the application(protocol, port) to be load balanced. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" loadbalancer-listener-properties, "None", False, :ref:`LoadbalancerListenerType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerListenerReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-listener** PUT /loadbalancer-listener/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-listener** *optional*, "", `LoadbalancerListenerUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-listener** DELETE /loadbalancer-listener/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-listener** GET /loadbalancer-listeners *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-listener** POST /loadbalancer-listeners *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-listener** *required*, "Body of loadbalancer-listener resource", `LoadbalancerListenerCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _loadbalancer-member-label: loadbalancer-member ------------------- Data Model ^^^^^^^^^^ *Description* Configuration object representing each member of load balancer pool. *Parents*: :ref:`loadbalancer-pool ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" loadbalancer-member-properties, "Member configuration like ip address, destination port, weight etc.", True, :ref:`LoadbalancerMemberType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerMemberReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-member** PUT /loadbalancer-member/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-member** *optional*, "", `LoadbalancerMemberUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-member** DELETE /loadbalancer-member/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-member** GET /loadbalancer-members *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-member** POST /loadbalancer-members *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-member** *required*, "Body of loadbalancer-member resource", `LoadbalancerMemberCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _loadbalancer-pool-label: loadbalancer-pool ----------------- Data Model ^^^^^^^^^^ *Description* Loadbalancer pool object represent set(pool) member servers which needs load balancing. *Parents*: :ref:`project ` *Children* :ref:`loadbalancer-member ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" loadbalancer-pool-properties, "Configuration for loadbalancer pool like protocol, subnet, etc.", True, :ref:`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, :ref:`KeyValuePairs `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LoadbalancerPoolReadAll`_ **404**, "Not Found", `Error`_ **Update a specific loadbalancer-pool** PUT /loadbalancer-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **loadbalancer-pool** *optional*, "", `LoadbalancerPoolUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific loadbalancer-pool** DELETE /loadbalancer-pool/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of loadbalancer-pool** GET /loadbalancer-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new loadbalancer-pool** POST /loadbalancer-pools *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **loadbalancer-pool** *required*, "Body of loadbalancer-pool resource", `LoadbalancerPoolCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _logical-interface-label: 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*: :ref:`physical-router `, :ref:`physical-interface ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LogicalInterfaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific logical-interface** PUT /logical-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **logical-interface** *optional*, "", `LogicalInterfaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific logical-interface** DELETE /logical-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of logical-interface** GET /logical-interfaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new logical-interface** POST /logical-interfaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **logical-interface** *required*, "Body of logical-interface resource", `LogicalInterfaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _logical-router-label: logical-router -------------- Data Model ^^^^^^^^^^ *Description* Logical router is a mechanism to connect multiple virtual network as they have been connected by a router. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `LogicalRouterReadAll`_ **404**, "Not Found", `Error`_ **Update a specific logical-router** PUT /logical-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **logical-router** *optional*, "", `LogicalRouterUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific logical-router** DELETE /logical-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of logical-router** GET /logical-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new logical-router** POST /logical-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **logical-router** *required*, "Body of logical-router resource", `LogicalRouterCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _multicast-policy-label: multicast-policy ---------------- Data Model ^^^^^^^^^^ *Description* List of references of child multicast policy objects. automatically maintained by system. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" multicast-source-groups, "List of Multicast (S,G) Addresses.", False, :ref:`MulticastSourceGroups `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `MulticastPolicyReadAll`_ **404**, "Not Found", `Error`_ **Update a specific multicast-policy** PUT /multicast-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **multicast-policy** *optional*, "", `MulticastPolicyUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific multicast-policy** DELETE /multicast-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of multicast-policy** GET /multicast-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new multicast-policy** POST /multicast-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **multicast-policy** *required*, "Body of multicast-policy resource", `MulticastPolicyCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _namespace-label: 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*: :ref:`domain ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" namespace-cidr, "All networks in this namespace belong to this list of Prefixes. Not implemented.", False, :ref:`SubnetType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FabricNamespaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific fabric-namespace** PUT /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **fabric-namespace** *optional*, "", `FabricNamespaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific fabric-namespace** DELETE /fabric-namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of fabric-namespace** GET /fabric-namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new fabric-namespace** POST /fabric-namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **fabric-namespace** *required*, "Body of fabric-namespace resource", `FabricNamespaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific namespace** GET /namespace/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NamespaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific namespace** PUT /namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **namespace** *optional*, "", `NamespaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific namespace** DELETE /namespace/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of namespace** GET /namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new namespace** POST /namespaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **namespace** *required*, "Body of namespace resource", `NamespaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _netconf-profile-label: netconf-profile --------------- Data Model ^^^^^^^^^^ *Description* This resource contains information specific to netconf parameters *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`NetconfParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NetconfProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific netconf-profile** PUT /netconf-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **netconf-profile** *optional*, "", `NetconfProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific netconf-profile** DELETE /netconf-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of netconf-profile** GET /netconf-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new netconf-profile** POST /netconf-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **netconf-profile** *required*, "Body of netconf-profile resource", `NetconfProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _network-device-config-label: network-device-config --------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NetworkDeviceConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific network-device-config** PUT /network-device-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **network-device-config** *optional*, "", `NetworkDeviceConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific network-device-config** DELETE /network-device-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new network-device-config** POST /network-device-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **network-device-config** *required*, "Body of network-device-config resource", `NetworkDeviceConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _network-ipam-label: network-ipam ------------ Data Model ^^^^^^^^^^ *Description* IP Address Management object that controls, ip allocation, DNS and DHCP *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" network-ipam-mgmt, "Network IP Address Management configuration.", False, :ref:`IpamType `, CRUD, user ipam-subnets, "List of subnets for this ipam.", False, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NetworkIpamReadAll`_ **404**, "Not Found", `Error`_ **Update a specific network-ipam** PUT /network-ipam/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **network-ipam** *optional*, "", `NetworkIpamUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific network-ipam** DELETE /network-ipam/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of network-ipam** GET /network-ipams *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new network-ipam** POST /network-ipams *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **network-ipam** *required*, "Body of network-ipam resource", `NetworkIpamCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _network-policy-label: 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*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" network-policy-entries, "Network policy rule entries.", True, :ref:`PolicyEntriesType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NetworkPolicyReadAll`_ **404**, "Not Found", `Error`_ **Update a specific network-policy** PUT /network-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **network-policy** *optional*, "", `NetworkPolicyUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific network-policy** DELETE /network-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of network-policy** GET /network-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new network-policy** POST /network-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **network-policy** *required*, "Body of network-policy resource", `NetworkPolicyCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _node-label: node ---- Data Model ^^^^^^^^^^ *Description* Parent of this node resource. *Parents*: :ref:`global-system-config ` *Children* :ref:`port `, :ref:`port-group ` *Properties* .. csv-table:: :header: "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, :ref:`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, :ref:`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, :ref:`CloudInstanceInfo `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsAlarmNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-alarm-node** PUT /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-alarm-node** *optional*, "", `AnalyticsAlarmNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-alarm-node** DELETE /analytics-alarm-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-alarm-node** POST /analytics-alarm-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-alarm-node** *required*, "Body of analytics-alarm-node resource", `AnalyticsAlarmNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific analytics-node** GET /analytics-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-node** PUT /analytics-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-node** *optional*, "", `AnalyticsNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-node** DELETE /analytics-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of analytics-node** GET /analytics-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-node** POST /analytics-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-node** *required*, "Body of analytics-node resource", `AnalyticsNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific analytics-snmp-node** GET /analytics-snmp-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `AnalyticsSnmpNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific analytics-snmp-node** PUT /analytics-snmp-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **analytics-snmp-node** *optional*, "", `AnalyticsSnmpNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific analytics-snmp-node** DELETE /analytics-snmp-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new analytics-snmp-node** POST /analytics-snmp-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **analytics-snmp-node** *required*, "Body of analytics-snmp-node resource", `AnalyticsSnmpNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific config-database-node** GET /config-database-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigDatabaseNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-database-node** PUT /config-database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-database-node** *optional*, "", `ConfigDatabaseNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-database-node** DELETE /config-database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-database-node** POST /config-database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-database-node** *required*, "Body of config-database-node resource", `ConfigDatabaseNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific config-node** GET /config-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ConfigNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific config-node** PUT /config-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **config-node** *optional*, "", `ConfigNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific config-node** DELETE /config-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of config-node** GET /config-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new config-node** POST /config-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **config-node** *required*, "Body of config-node resource", `ConfigNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific control-node-zone** GET /control-node-zone/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ControlNodeZoneReadAll`_ **404**, "Not Found", `Error`_ **Update a specific control-node-zone** PUT /control-node-zone/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **control-node-zone** *optional*, "", `ControlNodeZoneUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific control-node-zone** DELETE /control-node-zone/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new control-node-zone** POST /control-node-zones *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **control-node-zone** *required*, "Body of control-node-zone resource", `ControlNodeZoneCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific database-node** GET /database-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DatabaseNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific database-node** PUT /database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **database-node** *optional*, "", `DatabaseNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific database-node** DELETE /database-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of database-node** GET /database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new database-node** POST /database-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **database-node** *required*, "Body of database-node resource", `DatabaseNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific devicemgr-node** GET /devicemgr-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `DevicemgrNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific devicemgr-node** PUT /devicemgr-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **devicemgr-node** *optional*, "", `DevicemgrNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific devicemgr-node** DELETE /devicemgr-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of devicemgr-node** GET /devicemgr-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new devicemgr-node** POST /devicemgr-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **devicemgr-node** *required*, "Body of devicemgr-node resource", `DevicemgrNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific flow-node** GET /flow-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `FlowNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific flow-node** PUT /flow-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **flow-node** *optional*, "", `FlowNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific flow-node** DELETE /flow-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of flow-node** GET /flow-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new flow-node** POST /flow-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **flow-node** *required*, "Body of flow-node resource", `FlowNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific node** GET /node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific node** PUT /node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **node** *optional*, "", `NodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific node** DELETE /node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of node** GET /nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new node** POST /nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **node** *required*, "Body of node resource", `NodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific node-profile** GET /node-profile/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NodeProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific node-profile** PUT /node-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **node-profile** *optional*, "", `NodeProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific node-profile** DELETE /node-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of node-profile** GET /node-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new node-profile** POST /node-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **node-profile** *required*, "Body of node-profile resource", `NodeProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific webui-node** GET /webui-node/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `WebuiNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific webui-node** PUT /webui-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **webui-node** *optional*, "", `WebuiNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific webui-node** DELETE /webui-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of webui-node** GET /webui-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new webui-node** POST /webui-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **webui-node** *required*, "Body of webui-node resource", `WebuiNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _node-profile-label: 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* .. csv-table:: :header: "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, :ref:`NodeProfileRolesType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `NodeProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific node-profile** PUT /node-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **node-profile** *optional*, "", `NodeProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific node-profile** DELETE /node-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of node-profile** GET /node-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new node-profile** POST /node-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **node-profile** *required*, "Body of node-profile resource", `NodeProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _overlay-role-label: overlay-role ------------ Data Model ^^^^^^^^^^ *Description* Defines an overlay role *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `OverlayRoleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific overlay-role** PUT /overlay-role/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **overlay-role** *optional*, "", `OverlayRoleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific overlay-role** DELETE /overlay-role/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of overlay-role** GET /overlay-roles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new overlay-role** POST /overlay-roles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **overlay-role** *required*, "Body of overlay-role resource", `OverlayRoleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _peering-policy-label: peering-policy -------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" peering-service, "Peering policy service type.", True, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PeeringPolicyReadAll`_ **404**, "Not Found", `Error`_ **Update a specific peering-policy** PUT /peering-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **peering-policy** *optional*, "", `PeeringPolicyUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific peering-policy** DELETE /peering-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of peering-policy** GET /peering-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new peering-policy** POST /peering-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **peering-policy** *required*, "Body of peering-policy resource", `PeeringPolicyCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _physical-interface-label: physical-interface ------------------ Data Model ^^^^^^^^^^ *Description* Physical interfaces on physical routers. *Parents*: :ref:`physical-router ` *Children* :ref:`logical-interface ` *Properties* .. csv-table:: :header: "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, :ref:`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, :ref:`PortParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PhysicalInterfaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific physical-interface** PUT /physical-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **physical-interface** *optional*, "", `PhysicalInterfaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific physical-interface** DELETE /physical-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of physical-interface** GET /physical-interfaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new physical-interface** POST /physical-interfaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **physical-interface** *required*, "Body of physical-interface resource", `PhysicalInterfaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _physical-role-label: physical-role ------------- Data Model ^^^^^^^^^^ *Description* Defines a physical role *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PhysicalRoleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific physical-role** PUT /physical-role/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **physical-role** *optional*, "", `PhysicalRoleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific physical-role** DELETE /physical-role/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of physical-role** GET /physical-roles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new physical-role** POST /physical-roles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **physical-role** *required*, "Body of physical-role resource", `PhysicalRoleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _physical-router-label: physical-router --------------- Data Model ^^^^^^^^^^ *Description* Physical router object represent any physical device that participates in virtual networking, like routers, switches, servers, firewalls etc. *Parents*: :ref:`global-system-config ` *Children* :ref:`cli-config `, :ref:`hardware-inventory `, :ref:`link-aggregation-group `, :ref:`logical-interface `, :ref:`physical-interface ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" physical-router-junos-service-ports, "Juniper JUNOS specific service interfaces name to perform services like NAT.", False, :ref:`JunosServicePorts `, CRUD, user telemetry-info, "Telemetry info of router. Check TelemetryStateInfo", False, :ref:`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, :ref:`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, :ref:`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, :ref:`SNMPCredentials `, CRUD, user physical-router-dhcp-parameters, "Dnsmasq lease parameters for the physical router.", False, :ref:`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, :ref:`AutonomousSystemsType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PhysicalRouterReadAll`_ **404**, "Not Found", `Error`_ **Update a specific physical-router** PUT /physical-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **physical-router** *optional*, "", `PhysicalRouterUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific physical-router** DELETE /physical-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of physical-router** GET /physical-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new physical-router** POST /physical-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **physical-router** *required*, "Body of physical-router resource", `PhysicalRouterCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _policy-management-label: policy-management ----------------- Data Model ^^^^^^^^^^ *Description* When parent is project, Project level policy-management object re-grouping project policy resources *Parents*: :ref:`project ` *Children* :ref:`address-group `, :ref:`application-policy-set `, :ref:`firewall-policy `, :ref:`firewall-rule `, :ref:`service-group ` *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PolicyManagementReadAll`_ **404**, "Not Found", `Error`_ **Update a specific policy-management** PUT /policy-management/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **policy-management** *optional*, "", `PolicyManagementUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific policy-management** DELETE /policy-management/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of policy-management** GET /policy-managements *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new policy-management** POST /policy-managements *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **policy-management** *required*, "Body of policy-management resource", `PolicyManagementCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _port-label: port ---- Data Model ^^^^^^^^^^ *Description* Parent of this port. *Parents*: :ref:`node ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`BaremetalPortInfo `, CRUD, user esxi-port-info, "Information related to Port-ESXi/vCenter", False, :ref:`ESXIProperties `, CRUD, user label, "Label of the interface representing the use of the interface.", False, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port** PUT /port/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port** *optional*, "", `PortUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port** DELETE /port/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port** GET /ports *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port** POST /ports *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port** *required*, "Body of port resource", `PortCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific port-group** GET /port-group/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port-group** PUT /port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port-group** *optional*, "", `PortGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port-group** DELETE /port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port-group** GET /port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port-group** POST /port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port-group** *required*, "Body of port-group resource", `PortGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific port-profile** GET /port-profile/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port-profile** PUT /port-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port-profile** *optional*, "", `PortProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port-profile** DELETE /port-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port-profile** GET /port-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port-profile** POST /port-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port-profile** *required*, "Body of port-profile resource", `PortProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific port-tuple** GET /port-tuple/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortTupleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port-tuple** PUT /port-tuple/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port-tuple** *optional*, "", `PortTupleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port-tuple** DELETE /port-tuple/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port-tuple** GET /port-tuples *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port-tuple** POST /port-tuples *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port-tuple** *required*, "Body of port-tuple resource", `PortTupleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific virtual-port-group** GET /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualPortGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-port-group** PUT /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-port-group** *optional*, "", `VirtualPortGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-port-group** DELETE /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-port-group** POST /virtual-port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-port-group** *required*, "Body of virtual-port-group resource", `VirtualPortGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _port-group-label: port-group ---------- Data Model ^^^^^^^^^^ *Description* Parent of this port group. *Parents*: :ref:`node ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" bms-port-group-info, "Details of the baremetal server port group", False, :ref:`BaremetalPortGroupInfo `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port-group** PUT /port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port-group** *optional*, "", `PortGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port-group** DELETE /port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port-group** GET /port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port-group** POST /port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port-group** *required*, "Body of port-group resource", `PortGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific virtual-port-group** GET /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualPortGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-port-group** PUT /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-port-group** *optional*, "", `VirtualPortGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-port-group** DELETE /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-port-group** POST /virtual-port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-port-group** *required*, "Body of virtual-port-group resource", `VirtualPortGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _port-profile-label: port-profile ------------ Data Model ^^^^^^^^^^ *Description* Encapsulates port configurations like storm control, QoS etc *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" port-profile-params, "This is to configure port attributes.", False, :ref:`PortProfileParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port-profile** PUT /port-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port-profile** *optional*, "", `PortProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port-profile** DELETE /port-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port-profile** GET /port-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port-profile** POST /port-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port-profile** *required*, "Body of port-profile resource", `PortProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _port-tuple-label: 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*: :ref:`service-instance ` *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `PortTupleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific port-tuple** PUT /port-tuple/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **port-tuple** *optional*, "", `PortTupleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific port-tuple** DELETE /port-tuple/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of port-tuple** GET /port-tuples *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new port-tuple** POST /port-tuples *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **port-tuple** *required*, "Body of port-tuple resource", `PortTupleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _project-label: project ------- Data Model ^^^^^^^^^^ *Description* Project represent one instance of application or tenant. *Parents*: :ref:`domain ` *Children* :ref:`address-group `, :ref:`alarm `, :ref:`api-access-list `, :ref:`application-policy-set `, :ref:`bgp-as-a-service `, :ref:`bgpvpn `, :ref:`firewall-policy `, :ref:`firewall-rule `, :ref:`host-based-service `, :ref:`interface-route-table `, :ref:`loadbalancer `, :ref:`loadbalancer-healthmonitor `, :ref:`loadbalancer-listener `, :ref:`loadbalancer-pool `, :ref:`logical-router `, :ref:`multicast-policy `, :ref:`network-ipam `, :ref:`network-policy `, :ref:`policy-management `, :ref:`qos-config `, :ref:`route-aggregate `, :ref:`route-table `, :ref:`routing-policy `, :ref:`security-group `, :ref:`security-logging-object `, :ref:`service-group `, :ref:`service-health-check `, :ref:`service-instance `, :ref:`tag `, :ref:`virtual-ip `, :ref:`virtual-machine-interface `, :ref:`virtual-network `, :ref:`virtual-port-group ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" quota, "Max instances limits for various objects under project.", True, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ProjectReadAll`_ **404**, "Not Found", `Error`_ **Update a specific project** PUT /project/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **project** *optional*, "", `ProjectUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific project** DELETE /project/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of project** GET /projects *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new project** POST /projects *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **project** *required*, "Body of project resource", `ProjectCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _provider-attachment-label: provider-attachment ------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ProviderAttachmentReadAll`_ **404**, "Not Found", `Error`_ **Update a specific provider-attachment** PUT /provider-attachment/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **provider-attachment** *optional*, "", `ProviderAttachmentUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific provider-attachment** DELETE /provider-attachment/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of provider-attachment** GET /provider-attachments *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new provider-attachment** POST /provider-attachments *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **provider-attachment** *required*, "Body of provider-attachment resource", `ProviderAttachmentCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _qos-config-label: 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*: :ref:`global-qos-config `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`QosIdForwardingClassPairs `, CRUD, user vlan-priority-entries, "Map of .1p priority code to applicable forwarding class for packet.", False, :ref:`QosIdForwardingClassPairs `, CRUD, user mpls-exp-entries, "Map of MPLS EXP values to applicable forwarding class for packet.", False, :ref:`QosIdForwardingClassPairs `, CRUD, user default-forwarding-class-id, "Default forwarding class used for all non-specified QOS bits", True, number, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `GlobalQosConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific global-qos-config** PUT /global-qos-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **global-qos-config** *optional*, "", `GlobalQosConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific global-qos-config** DELETE /global-qos-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new global-qos-config** POST /global-qos-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **global-qos-config** *required*, "Body of global-qos-config resource", `GlobalQosConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific qos-config** GET /qos-config/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `QosConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific qos-config** PUT /qos-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **qos-config** *optional*, "", `QosConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific qos-config** DELETE /qos-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of qos-config** GET /qos-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new qos-config** POST /qos-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **qos-config** *required*, "Body of qos-config resource", `QosConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _qos-queue-label: qos-queue --------- Data Model ^^^^^^^^^^ *Description* QOS queue config object in this project. *Parents*: :ref:`global-qos-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `QosQueueReadAll`_ **404**, "Not Found", `Error`_ **Update a specific qos-queue** PUT /qos-queue/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **qos-queue** *optional*, "", `QosQueueUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific qos-queue** DELETE /qos-queue/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of qos-queue** GET /qos-queues *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new qos-queue** POST /qos-queues *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **qos-queue** *required*, "Body of qos-queue resource", `QosQueueCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _role-config-label: 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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RoleConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific role-config** PUT /role-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **role-config** *optional*, "", `RoleConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific role-config** DELETE /role-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of role-config** GET /role-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new role-config** POST /role-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **role-config** *required*, "Body of role-config resource", `RoleConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _role-definition-label: 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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RoleDefinitionReadAll`_ **404**, "Not Found", `Error`_ **Update a specific role-definition** PUT /role-definition/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **role-definition** *optional*, "", `RoleDefinitionUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific role-definition** DELETE /role-definition/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of role-definition** GET /role-definitions *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new role-definition** POST /role-definitions *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **role-definition** *required*, "Body of role-definition resource", `RoleDefinitionCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _route-aggregate-label: route-aggregate --------------- Data Model ^^^^^^^^^^ *Description* List of references of child routing route aggregate objects. automatically maintained by system. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`RouteListType `, CRUD, user aggregate-route-nexthop, "Next for aggregate route that will be advertised.", True, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RouteAggregateReadAll`_ **404**, "Not Found", `Error`_ **Update a specific route-aggregate** PUT /route-aggregate/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **route-aggregate** *optional*, "", `RouteAggregateUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific route-aggregate** DELETE /route-aggregate/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of route-aggregate** GET /route-aggregates *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new route-aggregate** POST /route-aggregates *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **route-aggregate** *required*, "Body of route-aggregate resource", `RouteAggregateCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _route-table-label: route-table ----------- Data Model ^^^^^^^^^^ *Description* Network route table is mechanism of adding static routes in the virtual network *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" routes, "Routes in the route table are configured in following way.", True, :ref:`RouteTableType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `InterfaceRouteTableReadAll`_ **404**, "Not Found", `Error`_ **Update a specific interface-route-table** PUT /interface-route-table/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **interface-route-table** *optional*, "", `InterfaceRouteTableUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific interface-route-table** DELETE /interface-route-table/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new interface-route-table** POST /interface-route-tables *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **interface-route-table** *required*, "Body of interface-route-table resource", `InterfaceRouteTableCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific route-table** GET /route-table/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RouteTableReadAll`_ **404**, "Not Found", `Error`_ **Update a specific route-table** PUT /route-table/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **route-table** *optional*, "", `RouteTableUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific route-table** DELETE /route-table/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of route-table** GET /route-tables *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new route-table** POST /route-tables *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **route-table** *required*, "Body of route-table resource", `RouteTableCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _route-target-label: route-target ------------ Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RouteTargetReadAll`_ **404**, "Not Found", `Error`_ **Update a specific route-target** PUT /route-target/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **route-target** *optional*, "", `RouteTargetUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific route-target** DELETE /route-target/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of route-target** GET /route-targets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new route-target** POST /route-targets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **route-target** *required*, "Body of route-target resource", `RouteTargetCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _routing-instance-label: routing-instance ---------------- Data Model ^^^^^^^^^^ *Description* List of references of routing instances for this virtual network, routing instances are internal to the system. *Parents*: :ref:`virtual-network ` *Children* :ref:`bgp-router ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" service-chain-information, "Internal service chaining information, should not be modified.", False, :ref:`ServiceChainInfo `, CRUD, system ipv6-service-chain-information, "Internal service chaining information, should not be modified.", False, :ref:`ServiceChainInfo `, CRUD, system evpn-service-chain-information, "Internal service chaining information, should not be modified.", False, :ref:`ServiceChainInfo `, CRUD, system evpn-ipv6-service-chain-information, "Internal service chaining information, should not be modified.", False, :ref:`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 static-route-entries, "Internal service chaining information, should not be modified.", False, :ref:`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, :ref:`DefaultProtocolType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RoutingInstanceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific routing-instance** PUT /routing-instance/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **routing-instance** *optional*, "", `RoutingInstanceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific routing-instance** DELETE /routing-instance/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of routing-instance** GET /routing-instances *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new routing-instance** POST /routing-instances *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **routing-instance** *required*, "Body of routing-instance resource", `RoutingInstanceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _routing-policy-label: routing-policy -------------- Data Model ^^^^^^^^^^ *Description* List of references of child routing policy objects. automatically maintained by system. *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" routing-policy-entries, "None", False, :ref:`PolicyStatementType `, CRUD, user term-type, "None", False, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `RoutingPolicyReadAll`_ **404**, "Not Found", `Error`_ **Update a specific routing-policy** PUT /routing-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **routing-policy** *optional*, "", `RoutingPolicyUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific routing-policy** DELETE /routing-policy/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of routing-policy** GET /routing-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new routing-policy** POST /routing-policys *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **routing-policy** *required*, "Body of routing-policy resource", `RoutingPolicyCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _security-group-label: 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*: :ref:`project ` *Children* :ref:`access-control-list ` *Properties* .. csv-table:: :header: "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, :ref:`PolicyEntriesType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `SecurityGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific security-group** PUT /security-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **security-group** *optional*, "", `SecurityGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific security-group** DELETE /security-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of security-group** GET /security-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new security-group** POST /security-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **security-group** *required*, "Body of security-group resource", `SecurityGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _security-logging-object-label: 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*: :ref:`global-vrouter-config `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" security-logging-object-rules, "Security logging object rules derived internally.", False, :ref:`SecurityLoggingObjectRuleListType `, CRUD, user security-logging-object-rate, "Security logging object rate defining rate of session logging", False, number, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `SecurityLoggingObjectReadAll`_ **404**, "Not Found", `Error`_ **Update a specific security-logging-object** PUT /security-logging-object/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **security-logging-object** *optional*, "", `SecurityLoggingObjectUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific security-logging-object** DELETE /security-logging-object/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new security-logging-object** POST /security-logging-objects *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **security-logging-object** *required*, "Body of security-logging-object resource", `SecurityLoggingObjectCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-appliance-label: 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*: :ref:`service-appliance-set ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" service-appliance-user-credentials, "Authentication credentials for driver to access service appliance.", False, :ref:`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, :ref:`KeyValuePairs `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceApplianceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-appliance** PUT /service-appliance/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-appliance** *optional*, "", `ServiceApplianceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-appliance** DELETE /service-appliance/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of service-appliance** GET /service-appliances *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-appliance** POST /service-appliances *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-appliance** *required*, "Body of service-appliance resource", `ServiceApplianceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific service-appliance-set** GET /service-appliance-set/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceApplianceSetReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-appliance-set** PUT /service-appliance-set/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-appliance-set** *optional*, "", `ServiceApplianceSetUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-appliance-set** DELETE /service-appliance-set/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-appliance-set** POST /service-appliance-sets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-appliance-set** *required*, "Body of service-appliance-set resource", `ServiceApplianceSetCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-appliance-set-label: 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*: :ref:`global-system-config ` *Children* :ref:`service-appliance ` *Properties* .. csv-table:: :header: "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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceApplianceSetReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-appliance-set** PUT /service-appliance-set/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-appliance-set** *optional*, "", `ServiceApplianceSetUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-appliance-set** DELETE /service-appliance-set/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-appliance-set** POST /service-appliance-sets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-appliance-set** *required*, "Body of service-appliance-set resource", `ServiceApplianceSetCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-connection-module-label: service-connection-module ------------------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceConnectionModuleReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-connection-module** PUT /service-connection-module/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-connection-module** *optional*, "", `ServiceConnectionModuleUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-connection-module** DELETE /service-connection-module/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-connection-module** POST /service-connection-modules *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-connection-module** *required*, "Body of service-connection-module resource", `ServiceConnectionModuleCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-endpoint-label: service-endpoint ---------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceEndpointReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-endpoint** PUT /service-endpoint/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-endpoint** *optional*, "", `ServiceEndpointUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-endpoint** DELETE /service-endpoint/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of service-endpoint** GET /service-endpoints *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-endpoint** POST /service-endpoints *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-endpoint** *required*, "Body of service-endpoint resource", `ServiceEndpointCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-group-label: service-group ------------- Data Model ^^^^^^^^^^ *Description* When parent is policy-management, Service Group object When parent is project, Project level service Group object *Parents*: :ref:`policy-management `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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, :ref:`FirewallServiceGroupType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-group** PUT /service-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-group** *optional*, "", `ServiceGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-group** DELETE /service-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of service-group** GET /service-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-group** POST /service-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-group** *required*, "Body of service-group resource", `ServiceGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-health-check-label: 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*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" service-health-check-properties, "Service health check has following fields.", True, :ref:`ServiceHealthCheckType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceHealthCheckReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-health-check** PUT /service-health-check/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-health-check** *optional*, "", `ServiceHealthCheckUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-health-check** DELETE /service-health-check/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-health-check** POST /service-health-checks *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-health-check** *required*, "Body of service-health-check resource", `ServiceHealthCheckCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-instance-label: 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*: :ref:`project ` *Children* :ref:`port-tuple ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" service-instance-properties, "Service instance configuration parameters.", True, :ref:`ServiceInstanceType `, CRUD, user service-instance-bindings, "Opaque key value pair for generating config for the service instance.", False, :ref:`KeyValuePairs `, CRUD, user service-instance-bgp-enabled, "Enable BGP routing for this service instance", False, boolean, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceInstanceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-instance** PUT /service-instance/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-instance** *optional*, "", `ServiceInstanceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-instance** DELETE /service-instance/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of service-instance** GET /service-instances *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-instance** POST /service-instances *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-instance** *required*, "Body of service-instance resource", `ServiceInstanceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-object-label: service-object -------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceObjectReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-object** PUT /service-object/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-object** *optional*, "", `ServiceObjectUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-object** DELETE /service-object/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of service-object** GET /service-objects *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-object** POST /service-objects *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-object** *required*, "Body of service-object resource", `ServiceObjectCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _service-template-label: 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*: :ref:`domain ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" service-template-properties, "Service template configuration parameters.", True, :ref:`ServiceTemplateType `, CRUD, user service-config-managed, "Enable whether service config for PNFs needs to be managed by Contrail", False, boolean, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ServiceTemplateReadAll`_ **404**, "Not Found", `Error`_ **Update a specific service-template** PUT /service-template/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **service-template** *optional*, "", `ServiceTemplateUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific service-template** DELETE /service-template/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of service-template** GET /service-templates *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new service-template** POST /service-templates *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **service-template** *required*, "Body of service-template resource", `ServiceTemplateCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _sflow-profile-label: sflow-profile ------------- Data Model ^^^^^^^^^^ *Description* This resource contains information specific to sflow parameters *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`SflowParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `SflowProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific sflow-profile** PUT /sflow-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **sflow-profile** *optional*, "", `SflowProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific sflow-profile** DELETE /sflow-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of sflow-profile** GET /sflow-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new sflow-profile** POST /sflow-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **sflow-profile** *required*, "Body of sflow-profile resource", `SflowProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _snmp-profile-label: snmp-profile ------------ Data Model ^^^^^^^^^^ *Description* This resource contains information specific to snmp parameters *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`SnmpParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `SnmpProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific snmp-profile** PUT /snmp-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **snmp-profile** *optional*, "", `SnmpProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific snmp-profile** DELETE /snmp-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of snmp-profile** GET /snmp-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new snmp-profile** POST /snmp-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **snmp-profile** *required*, "Body of snmp-profile resource", `SnmpProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _storm-control-profile-label: storm-control-profile --------------------- Data Model ^^^^^^^^^^ *Description* Storm control profile definition *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`StormControlParameters `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `StormControlProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific storm-control-profile** PUT /storm-control-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **storm-control-profile** *optional*, "", `StormControlProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific storm-control-profile** DELETE /storm-control-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new storm-control-profile** POST /storm-control-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **storm-control-profile** *required*, "Body of storm-control-profile resource", `StormControlProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _structured-syslog-application-record-label: structured-syslog-application-record ------------------------------------ Data Model ^^^^^^^^^^ *Description* mapping App name to other entities *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **structured-syslog-application-record** *optional*, "", `StructuredSyslogApplicationRecordUpdate`_, *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new structured-syslog-application-record** POST /structured-syslog-application-records *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **structured-syslog-application-record** *required*, "Body of structured-syslog-application-record resource", `StructuredSyslogApplicationRecordCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _structured-syslog-config-label: structured-syslog-config ------------------------ Data Model ^^^^^^^^^^ *Description* structured syslog config related data *Parents*: None *Children* None *Properties* *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `StructuredSyslogConfigReadAll`_ **404**, "Not Found", `Error`_ **Update a specific structured-syslog-config** PUT /structured-syslog-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **structured-syslog-config** *optional*, "", `StructuredSyslogConfigUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific structured-syslog-config** DELETE /structured-syslog-config/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new structured-syslog-config** POST /structured-syslog-configs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **structured-syslog-config** *required*, "Body of structured-syslog-config resource", `StructuredSyslogConfigCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _structured-syslog-hostname-record-label: structured-syslog-hostname-record --------------------------------- Data Model ^^^^^^^^^^ *Description* mapping Hostname to other entities *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`StructuredSyslogLinkmap `, CRUD, user structured-syslog-lan-segment-list, "vpn to network-ranges mapping", False, :ref:`StructuredSyslogLANSegmentList `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **structured-syslog-hostname-record** *optional*, "", `StructuredSyslogHostnameRecordUpdate`_, *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new structured-syslog-hostname-record** POST /structured-syslog-hostname-records *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **structured-syslog-hostname-record** *required*, "Body of structured-syslog-hostname-record resource", `StructuredSyslogHostnameRecordCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _structured-syslog-message-label: structured-syslog-message ------------------------- Data Model ^^^^^^^^^^ *Description* structured syslog messages to be handled *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" structured-syslog-message-tagged-fields, "list of field names in the message to be tagged", True, :ref:`FieldNamesList `, CRUD, user structured-syslog-message-integer-fields, "list of integer fields in the message", True, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `StructuredSyslogMessageReadAll`_ **404**, "Not Found", `Error`_ **Update a specific structured-syslog-message** PUT /structured-syslog-message/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **structured-syslog-message** *optional*, "", `StructuredSyslogMessageUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific structured-syslog-message** DELETE /structured-syslog-message/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new structured-syslog-message** POST /structured-syslog-messages *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **structured-syslog-message** *required*, "Body of structured-syslog-message resource", `StructuredSyslogMessageCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _structured-syslog-sla-profile-label: structured-syslog-sla-profile ----------------------------- Data Model ^^^^^^^^^^ *Description* mapping sla-profile to sla params *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **structured-syslog-sla-profile** *optional*, "", `StructuredSyslogSlaProfileUpdate`_, *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new structured-syslog-sla-profile** POST /structured-syslog-sla-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **structured-syslog-sla-profile** *required*, "Body of structured-syslog-sla-profile resource", `StructuredSyslogSlaProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _structured-syslog-tenant-record-label: structured-syslog-tenant-record ------------------------------- Data Model ^^^^^^^^^^ *Description* mapping Tenant to other entities *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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, :ref:`StructuredSyslogDSCPMap `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **structured-syslog-tenant-record** *optional*, "", `StructuredSyslogTenantRecordUpdate`_, *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new structured-syslog-tenant-record** POST /structured-syslog-tenant-records *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **structured-syslog-tenant-record** *required*, "Body of structured-syslog-tenant-record resource", `StructuredSyslogTenantRecordCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _sub-cluster-label: sub-cluster ----------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `SubClusterReadAll`_ **404**, "Not Found", `Error`_ **Update a specific sub-cluster** PUT /sub-cluster/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **sub-cluster** *optional*, "", `SubClusterUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific sub-cluster** DELETE /sub-cluster/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of sub-cluster** GET /sub-clusters *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new sub-cluster** POST /sub-clusters *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **sub-cluster** *required*, "Body of sub-cluster resource", `SubClusterCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _subnet-label: subnet ------ Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" subnet-ip-prefix, "Ip prefix/length of the subnet.", True, :ref:`SubnetType `, CRD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `SubnetReadAll`_ **404**, "Not Found", `Error`_ **Update a specific subnet** PUT /subnet/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **subnet** *optional*, "", `SubnetUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific subnet** DELETE /subnet/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of subnet** GET /subnets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new subnet** POST /subnets *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **subnet** *required*, "Body of subnet resource", `SubnetCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _tag-label: tag --- Data Model ^^^^^^^^^^ *Description* When parent is project, Attribute attached to objects - has a type and value *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `TagReadAll`_ **404**, "Not Found", `Error`_ **Update a specific tag** PUT /tag/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **tag** *optional*, "", `TagUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific tag** DELETE /tag/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of tag** GET /tags *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new tag** POST /tags *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **tag** *required*, "Body of tag resource", `TagCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific tag-type** GET /tag-type/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `TagTypeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific tag-type** PUT /tag-type/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **tag-type** *optional*, "", `TagTypeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific tag-type** DELETE /tag-type/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of tag-type** GET /tag-types *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new tag-type** POST /tag-types *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **tag-type** *required*, "Body of tag-type resource", `TagTypeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _tag-type-label: tag-type -------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `TagTypeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific tag-type** PUT /tag-type/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **tag-type** *optional*, "", `TagTypeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific tag-type** DELETE /tag-type/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of tag-type** GET /tag-types *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new tag-type** POST /tag-types *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **tag-type** *required*, "Body of tag-type resource", `TagTypeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _telemetry-profile-label: telemetry-profile ----------------- Data Model ^^^^^^^^^^ *Description* Encapsulates data related to telemetry from network devices like sflow, JTI, gRPC, SNMP etc *Parents*: None *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `TelemetryProfileReadAll`_ **404**, "Not Found", `Error`_ **Update a specific telemetry-profile** PUT /telemetry-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **telemetry-profile** *optional*, "", `TelemetryProfileUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific telemetry-profile** DELETE /telemetry-profile/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of telemetry-profile** GET /telemetry-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new telemetry-profile** POST /telemetry-profiles *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **telemetry-profile** *required*, "Body of telemetry-profile resource", `TelemetryProfileCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-DNS-label: 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*: :ref:`domain ` *Children* :ref:`virtual-DNS-record ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" virtual-DNS-data, "Virtual DNS data has configuration for virtual DNS like domain, dynamic records etc.", True, :ref:`VirtualDnsType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualDnsReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-DNS** PUT /virtual-DNS/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-DNS** *optional*, "", `VirtualDnsUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-DNS** DELETE /virtual-DNS/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of virtual-DNS** GET /virtual-DNSs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-DNS** POST /virtual-DNSs *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-DNS** *required*, "Body of virtual-DNS resource", `VirtualDnsCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific virtual-DNS-record** GET /virtual-DNS-record/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualDnsRecordReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-DNS-record** PUT /virtual-DNS-record/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-DNS-record** *optional*, "", `VirtualDnsRecordUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-DNS-record** DELETE /virtual-DNS-record/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-DNS-record** POST /virtual-DNS-records *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-DNS-record** *required*, "Body of virtual-DNS-record resource", `VirtualDnsRecordCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-DNS-record-label: virtual-DNS-record ------------------ Data Model ^^^^^^^^^^ *Description* Static DNS records in virtual DNS server. *Parents*: :ref:`virtual-DNS ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" virtual-DNS-record-data, "DNS record data has configuration like type, name, ip address, loadbalancing etc.", True, :ref:`VirtualDnsRecordType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualDnsRecordReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-DNS-record** PUT /virtual-DNS-record/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-DNS-record** *optional*, "", `VirtualDnsRecordUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-DNS-record** DELETE /virtual-DNS-record/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-DNS-record** POST /virtual-DNS-records *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-DNS-record** *required*, "Body of virtual-DNS-record resource", `VirtualDnsRecordCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-ip-label: virtual-ip ---------- Data Model ^^^^^^^^^^ *Description* Virtual ip object application(protocol, port). Applicable only to LBaaS V1 *Parents*: :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" virtual-ip-properties, "Virtual ip configuration like port, protocol, subnet etc.", True, :ref:`VirtualIpType `, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualIpReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-ip** PUT /virtual-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-ip** *optional*, "", `VirtualIpUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-ip** DELETE /virtual-ip/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of virtual-ip** GET /virtual-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-ip** POST /virtual-ips *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-ip** *required*, "Body of virtual-ip resource", `VirtualIpCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-machine-label: virtual-machine --------------- Data Model ^^^^^^^^^^ *Description* *Parents*: None *Children* :ref:`virtual-machine-interface ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" server-type, "An enumeration value specifying the server type.", False, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualMachineReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-machine** PUT /virtual-machine/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-machine** *optional*, "", `VirtualMachineUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-machine** DELETE /virtual-machine/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of virtual-machine** GET /virtual-machines *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-machine** POST /virtual-machines *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-machine** *required*, "Body of virtual-machine resource", `VirtualMachineCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **Fetch a specific virtual-machine-interface** GET /virtual-machine-interface/{id} *Parameters* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualMachineInterfaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-machine-interface** PUT /virtual-machine-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-machine-interface** *optional*, "", `VirtualMachineInterfaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-machine-interface** DELETE /virtual-machine-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-machine-interface** POST /virtual-machine-interfaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-machine-interface** *required*, "Body of virtual-machine-interface resource", `VirtualMachineInterfaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-machine-interface-label: 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*: :ref:`virtual-machine `, :ref:`project `, :ref:`virtual-router ` *Children* None *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" ecmp-hashing-include-fields, "ECMP hashing config at global level.", False, :ref:`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, :ref:`MacAddressesType `, CRUD, user virtual-machine-interface-dhcp-option-list, "DHCP options configuration specific to this interface.", False, :ref:`DhcpOptionsListType `, CRUD, user virtual-machine-interface-host-routes, "List of host routes(prefixes, nexthop) that are passed to VM via DHCP.", False, :ref:`RouteTableType `, CRUD, user virtual-machine-interface-allowed-address-pairs, "List of (IP address, MAC) other than instance ip on this interface.", False, :ref:`AllowedAddressPairs `, CRUD, user vrf-assign-table, "VRF assignment policy for this interface, automatically generated by system.", False, :ref:`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, :ref:`VirtualMachineInterfacePropertiesType `, CRUD, user virtual-machine-interface-bindings, "Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.", False, :ref:`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, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualMachineInterfaceReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-machine-interface** PUT /virtual-machine-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-machine-interface** *optional*, "", `VirtualMachineInterfaceUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-machine-interface** DELETE /virtual-machine-interface/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-machine-interface** POST /virtual-machine-interfaces *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-machine-interface** *required*, "Body of virtual-machine-interface resource", `VirtualMachineInterfaceCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-network-label: 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*: :ref:`project ` *Children* :ref:`access-control-list `, :ref:`alias-ip-pool `, :ref:`bridge-domain `, :ref:`floating-ip-pool `, :ref:`routing-instance ` *Properties* .. csv-table:: :header: "Name", "Description", "Required", "Type", "Operations", "Created By" ecmp-hashing-include-fields, "ECMP hashing config at global level.", False, :ref:`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, :ref:`VirtualNetworkType `, CRUD, user virtual-network-routed-properties, "Attributes for routed virtual networks.", False, :ref:`VirtualNetworkRoutedPropertiesType `, CRUD, user provider-properties, "Virtual network is provider network. Specifies VLAN tag and physical network name.", False, :ref:`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, :ref:`RouteTargetList `, CRUD, user import-route-target-list, "List of route targets that are used as import for this virtual network.", False, :ref:`RouteTargetList `, CRUD, user export-route-target-list, "List of route targets that are used as export for this virtual network.", False, :ref:`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, :ref:`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, :ref:`MACLimitControlType `, CRUD, user mac-move-control, "MAC move control on the network", False, :ref:`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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualNetworkReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-network** PUT /virtual-network/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-network** *optional*, "", `VirtualNetworkUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-network** DELETE /virtual-network/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of virtual-network** GET /virtual-networks *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-network** POST /virtual-networks *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-network** *required*, "Body of virtual-network resource", `VirtualNetworkCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-port-group-label: 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*: :ref:`fabric `, :ref:`project ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualPortGroupReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-port-group** PUT /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-port-group** *optional*, "", `VirtualPortGroupUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-port-group** DELETE /virtual-port-group/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "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* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-port-group** POST /virtual-port-groups *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-port-group** *required*, "Body of virtual-port-group resource", `VirtualPortGroupCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _virtual-router-label: virtual-router -------------- Data Model ^^^^^^^^^^ *Description* Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s), routers. *Parents*: :ref:`global-system-config ` *Children* :ref:`virtual-machine-interface ` *Properties* .. csv-table:: :header: "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, :ref:`KeyValuePairs `, CRUD, user virtual-router-ip-address, "Ip address of the virtual router.", True, string, CRUD, user *References* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `VirtualRouterReadAll`_ **404**, "Not Found", `Error`_ **Update a specific virtual-router** PUT /virtual-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **virtual-router** *optional*, "", `VirtualRouterUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific virtual-router** DELETE /virtual-router/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of virtual-router** GET /virtual-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new virtual-router** POST /virtual-routers *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **virtual-router** *required*, "Body of virtual-router resource", `VirtualRouterCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ .. _webui-node-label: webui-node ---------- Data Model ^^^^^^^^^^ *Description* WebUI node is object representing a logical node in system which hosts the Contrail UI. *Parents*: :ref:`global-system-config ` *Children* None *Properties* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `WebuiNodeReadAll`_ **404**, "Not Found", `Error`_ **Update a specific webui-node** PUT /webui-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , **body**, **webui-node** *optional*, "", `WebuiNodeUpdate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Delete a specific webui-node** DELETE /webui-node/{id} *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **path**, **id** *required*, "The id of resource", , *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **409**, "Conflict", `Error`_ **List collection of webui-node** GET /webui-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **query**, **detail** *optional*, "Report all :ref:`property and reference ` fields of resource", boolean, False **query**, **fields** *optional*, "CSV List of specific :ref:`fields ` to report", string, fq_name, uuid, href **query**, **filters** *optional*, "CSV List of == 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* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `ResourceListSummary`_ **Create a new webui-node** POST /webui-nodes *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **webui-node** *required*, "Body of webui-node resource", `WebuiNodeCreate`_, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ Generic REST API ================ **Find resource id given its type and fqname** POST /fqname-to-id *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **type** *required*, "", string, **body**, **fq_name** *required*, "Fully Qualified Name of resource", "< string > array", *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `Uuid`_ **404**, "Not Found", `Error`_ **Find type and fqname given resource id** POST /id-to-fqname *Parameters* .. csv-table:: :header: "Type", "Name", "Description", "Schema", "Default" **body**, **uuid** *required*, "", string, *Responses* .. csv-table:: :header: "HTTP Code", "Description", "Schema" **200**, "Success", `TypeFQName`_ **404**, "Not Found", `Error`_ Definitions =========== .. _Error-label: Error ----- .. csv-table:: :header: "Name", "Description", "Schema" **message** *required*, "", string .. _Uuid-label: Uuid ---- .. csv-table:: :header: "Name", "Description", "Schema" **uuid** *required*, "", string .. _TypeFQName-label: TypeFQName ---------- .. csv-table:: :header: "Name", "Description", "Schema" **type** *required*, "", string **fq_name** *required*, "Fully Qualified Name of resource", "< string > array" .. _ResourceListSummary-label: ResourceListSummary ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **fq_name** *required*, "Fully Qualified Name of resource", "< string > array" **uuid** *required*, "", string **href** *required*, "", string .. _MacAddressesType-label: MacAddressesType ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **mac_address** *optional*, "", string .. _IpAddressesType-label: IpAddressesType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **ip_address** *optional*, "String of standard notation of ipv4 or ipv6 address", string .. _SubnetType-label: SubnetType ---------- .. csv-table:: :header: "Name", "Description", "Schema" **ip_prefix** *optional*, "", string **ip_prefix_len** *optional*, "", integer .. _VirtualRouterNetworkIpamType-label: VirtualRouterNetworkIpamType ---------------------------- .. csv-table:: :header: "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-label: AllowedAddressPairs ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **allowed_address_pair** *optional*, "", `AllowedAddressPair`_ .. _VirtualNetworkPolicyType-label: VirtualNetworkPolicyType ------------------------ .. csv-table:: :header: "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-label: PortMappings ------------ .. csv-table:: :header: "Name", "Description", "Schema" **port_mappings** *optional*, "", `PortMap`_ .. _ActionListType-label: ActionListType -------------- .. csv-table:: :header: "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-label: AclEntriesType -------------- .. csv-table:: :header: "Name", "Description", "Schema" **dynamic** *optional*, "For Internal use only", boolean **acl_rule** *required*, "For Internal use only", `AclRuleType`_ .. _PolicyEntriesType-label: PolicyEntriesType ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **policy_rule** *required*, "List of policy rules", `PolicyRuleType`_ .. _DhcpOptionsListType-label: DhcpOptionsListType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **dhcp_option** *optional*, "List of DHCP options", `DhcpOptionType`_ .. _DeviceFamilyListType-label: DeviceFamilyListType -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **device_family** *optional*, "", string .. _VendorHardwaresType-label: VendorHardwaresType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **vendor_hardware** *optional*, "", string .. _IpamType-label: IpamType -------- .. csv-table:: :header: "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-label: EncapsulationPrioritiesType --------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **encapsulation** *optional*, "Ordered list of encapsulation types to be used in priority", "Any of ['MPLSoGRE', 'MPLSoUDP', 'VXLAN']" .. _LinklocalServicesTypes-label: LinklocalServicesTypes ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **linklocal_service_entry** *optional*, "List of link local services", `LinklocalServiceEntryType`_ .. _VirtualDnsType-label: VirtualDnsType -------------- .. csv-table:: :header: "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-label: VirtualDnsRecordType -------------------- .. csv-table:: :header: "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-label: FloatingIpPoolSubnetType ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **subnet_uuid** *optional*, "List of subnets associated with this floating ip pool.", string .. _VnSubnetsType-label: VnSubnetsType ------------- .. csv-table:: :header: "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-label: RbacRuleEntriesType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **rbac_rule** *optional*, "", `RbacRuleType`_ .. _DomainLimitsType-label: DomainLimitsType ---------------- .. csv-table:: :header: "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-label: PluginProperties ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **plugin_property** *optional*, "List of plugin specific properties (property, value)", `PluginProperty`_ .. _QuotaType-label: QuotaType --------- .. csv-table:: :header: "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-label: FlowAgingTimeoutList -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **flow_aging_timeout** *optional*, "List of (ip protocol, port number, timeout in seconds)", `FlowAgingTimeout`_ .. _QosIdForwardingClassPairs-label: QosIdForwardingClassPairs ------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **qos_id_forwarding_class_pair** *optional*, "", `QosIdForwardingClassPair`_ .. _ControlTrafficDscpType-label: ControlTrafficDscpType ---------------------- .. csv-table:: :header: "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-label: GracefulRestartParametersType ----------------------------- .. csv-table:: :header: "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-label: FastConvergenceParametersType ----------------------------- .. csv-table:: :header: "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-label: PortTranslationPools -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **port_translation_pool** *optional*, "", `PortTranslationPool`_ .. _BGPaaSControlNodeZoneAttributes-label: BGPaaSControlNodeZoneAttributes ------------------------------- .. csv-table:: :header: "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-label: BGPaaServiceParametersType -------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **port_start** *optional*, "", integer **port_end** *optional*, "", integer .. _SecurityLoggingObjectRuleListType-label: SecurityLoggingObjectRuleListType --------------------------------- .. csv-table:: :header: "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-label: EcmpHashingIncludeFields ------------------------ .. csv-table:: :header: "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-label: EncryptionTunnelEndpointList ---------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **endpoint** *optional*, "Tunnel endpoint remote address", `EncryptionTunnelEndpoint`_ .. _VirtualNetworkRoutedPropertiesType-label: VirtualNetworkRoutedPropertiesType ---------------------------------- .. csv-table:: :header: "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-label: VirtualNetworkType ------------------ .. csv-table:: :header: "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-label: ProviderDetails --------------- .. csv-table:: :header: "Name", "Description", "Schema" **segmentation_id** *optional*, "", integer **physical_network** *optional*, "", string .. _RouteTargetList-label: RouteTargetList --------------- .. csv-table:: :header: "Name", "Description", "Schema" **route_target** *optional*, "", string .. _IpamSubnets-label: IpamSubnets ----------- .. csv-table:: :header: "Name", "Description", "Schema" **subnets** *optional*, "", `IpamSubnetType`_ .. _VrfAssignTableType-label: VrfAssignTableType ------------------ .. csv-table:: :header: "Name", "Description", "Schema" **vrf_assign_rule** *optional*, "", `VrfAssignRuleType`_ .. _ServiceInterfaceTag-label: ServiceInterfaceTag ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **interface_type** *optional*, "", string .. _RoutingPolicyServiceInstanceType-label: RoutingPolicyServiceInstanceType -------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **left_sequence** *optional*, "", string **right_sequence** *optional*, "", string .. _VirtualMachineInterfacePropertiesType-label: VirtualMachineInterfacePropertiesType ------------------------------------- .. csv-table:: :header: "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-label: FatFlowProtocols ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **fat_flow_protocol** *optional*, "", `ProtocolType`_ .. _PolicyBasedForwardingRuleType-label: PolicyBasedForwardingRuleType ----------------------------- .. csv-table:: :header: "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-label: JunosServicePorts ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **service_port** *optional*, "", string .. _ServiceTemplateType-label: ServiceTemplateType ------------------- .. csv-table:: :header: "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-label: ServiceInstanceType ------------------- .. csv-table:: :header: "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-label: RouteTableType -------------- .. csv-table:: :header: "Name", "Description", "Schema" **route** *optional*, "List of ip routes with following fields.", `RouteType`_ .. _ServiceHealthCheckType-label: ServiceHealthCheckType ---------------------- .. csv-table:: :header: "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-label: LogicalRouterVirtualNetworkType ------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **logical_router_virtual_network_type** *optional*, "", "Any of ['ExternalGateway', 'InternalVirtualNetwork', 'NAPTSourcePool']" .. _KeyValuePairs-label: KeyValuePairs ------------- .. csv-table:: :header: "Name", "Description", "Schema" **key_value_pair** *optional*, "", `KeyValuePair`_ .. _ServiceApplianceInterfaceType-label: ServiceApplianceInterfaceType ----------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **interface_type** *optional*, "", string .. _DiscoveryServiceAssignmentType-label: DiscoveryServiceAssignmentType ------------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **publisher** *required*, "Publisher set", `DiscoveryPubSubEndPointType`_ **subscriber** *required*, "subscriber set", `DiscoveryPubSubEndPointType`_ .. _MACLimitControlType-label: MACLimitControlType ------------------- .. csv-table:: :header: "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-label: MACMoveLimitControlType ----------------------- .. csv-table:: :header: "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-label: BridgeDomainMembershipType -------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **vlan_tag** *optional*, "VLAN tag of the incoming packet that maps the virtual- machine-interface to bridge domain", integer .. _AutonomousSystemsType-label: AutonomousSystemsType --------------------- .. csv-table:: :header: "Name", "Description", "Schema" **asn** *optional*, "", integer .. _MulticastSourceGroups-label: MulticastSourceGroups --------------------- .. csv-table:: :header: "Name", "Description", "Schema" **multicast_source_group** *optional*, "", `MulticastSourceGroup`_ .. _TelemetryStateInfo-label: TelemetryStateInfo ------------------ .. csv-table:: :header: "Name", "Description", "Schema" **resource** *optional*, "", `TelemetryResourceInfo`_ **server_ip** *optional*, "", string **server_port** *optional*, "", integer .. _LoadbalancerPoolType-label: LoadbalancerPoolType -------------------- .. csv-table:: :header: "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-label: LoadbalancerMemberType ---------------------- .. csv-table:: :header: "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-label: LoadbalancerHealthmonitorType ----------------------------- .. csv-table:: :header: "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-label: VirtualIpType ------------- .. csv-table:: :header: "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-label: LoadbalancerListenerType ------------------------ .. csv-table:: :header: "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-label: LoadbalancerType ---------------- .. csv-table:: :header: "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-label: AlarmOrList ----------- .. csv-table:: :header: "Name", "Description", "Schema" **or_list** *optional*, "", `AlarmAndList`_ .. _UveKeysType-label: UveKeysType ----------- .. csv-table:: :header: "Name", "Description", "Schema" **uve_key** *required*, "List of UVE tables where this alarm config should be applied", string .. _UserDefinedLogStatList-label: UserDefinedLogStatList ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **statlist** *optional*, "", `UserDefinedLogStat`_ .. _SloRateType-label: SloRateType ----------- .. csv-table:: :header: "Name", "Description", "Schema" **rate** *optional*, "Rate at which sessions are logged", integer .. _SubnetListType-label: SubnetListType -------------- .. csv-table:: :header: "Name", "Description", "Schema" **subnet** *optional*, "", `SubnetType`_ .. _FirewallServiceType-label: FirewallServiceType ------------------- .. csv-table:: :header: "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-label: FirewallServiceGroupType ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **firewall_service** *required*, "", `FirewallServiceType`_ .. _FirewallRuleEndpointType-label: FirewallRuleEndpointType ------------------------ .. csv-table:: :header: "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-label: FirewallRuleMatchTagsType ------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **tag_list** *required*, "", string .. _FirewallRuleMatchTagsTypeIdList-label: FirewallRuleMatchTagsTypeIdList ------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **tag_type** *required*, "", integer .. _FirewallSequence-label: FirewallSequence ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **sequence** *required*, "", string .. _ExecutableInfoListType-label: ExecutableInfoListType ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **executable_info** *optional*, "", `ExecutableInfoType`_ .. _PlaybookInfoListType-label: PlaybookInfoListType -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **playbook_info** *optional*, "", `PlaybookInfoType`_ .. _VpgInterfaceParametersType-label: VpgInterfaceParametersType -------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **ae_num** *optional*, "", integer .. _DeviceCredentialList-label: DeviceCredentialList -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **device_credential** *optional*, "", `DeviceCredential`_ .. _CliDiffListType-label: CliDiffListType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **commit_diff_info** *optional*, "", `CliDiffInfoType`_ .. _StormControlParameters-label: StormControlParameters ---------------------- .. csv-table:: :header: "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-label: SflowParameters --------------- .. csv-table:: :header: "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-label: GrpcParameters -------------- .. csv-table:: :header: "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-label: SnmpParameters -------------- .. csv-table:: :header: "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-label: NetconfParameters ----------------- .. csv-table:: :header: "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-label: PortParameters -------------- .. csv-table:: :header: "Name", "Description", "Schema" **port_disable** *optional*, "", boolean **port_mtu** *optional*, "", integer **port_description** *optional*, "", string .. _PortProfileParameters-label: PortProfileParameters --------------------- .. csv-table:: :header: "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-label: FabricNetworkTag ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **network_type** *optional*, "", "Any of ['management', 'loopback', 'ip-fabric', 'pnf-servicechain', 'overlay-loopback']" .. _SerialNumListType-label: SerialNumListType ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **serial_num** *optional*, "", string .. _AsnRangeType-label: AsnRangeType ------------ .. csv-table:: :header: "Name", "Description", "Schema" **asn_min** *optional*, "", integer **asn_max** *optional*, "", integer .. _NamespaceValue-label: NamespaceValue -------------- .. csv-table:: :header: "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-label: DevicePlatformListType ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **platform_name** *optional*, "", string .. _InterfaceMapType-label: InterfaceMapType ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **port_info** *optional*, "", `PortInfoType`_ .. _RoutingBridgingRolesType-label: RoutingBridgingRolesType ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **rb_roles** *optional*, "", string .. _NodeProfileRolesType-label: NodeProfileRolesType -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **role_mappings** *optional*, "", `NodeProfileRoleType`_ .. _UserCredentials-label: UserCredentials --------------- .. csv-table:: :header: "Name", "Description", "Schema" **username** *optional*, "", string **password** *optional*, "", string .. _SNMPCredentials-label: SNMPCredentials --------------- .. csv-table:: :header: "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-label: DnsmasqLeaseParameters ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **lease_expiry_time** *optional*, "", integer **client_id** *optional*, "", string .. _LogicalRouterPRListType-label: LogicalRouterPRListType ----------------------- .. csv-table:: :header: "Name", "Description", "Schema" **logical_router_list** *optional*, "List of Destination LRs properties", `LogicalRouterPRListParams`_ .. _VMIVirtualPortGroupAttributes-label: VMIVirtualPortGroupAttributes ----------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **vlan_tag** *optional*, "Tagged VLAN", integer **native_vlan_tag** *optional*, "Untagged VLAN", integer .. _ESXIProperties-label: ESXIProperties -------------- .. csv-table:: :header: "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-label: BaremetalPortInfo ----------------- .. csv-table:: :header: "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-label: CloudInstanceInfo ----------------- .. csv-table:: :header: "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-label: ESXIHostInfo ------------ .. csv-table:: :header: "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-label: BaremetalPortGroupInfo ---------------------- .. csv-table:: :header: "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-label: BaremetalServerInfo ------------------- .. csv-table:: :header: "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-label: ServiceVirtualNetworkType ------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **virtual_network_type** *optional*, "", string .. _RouteListType-label: RouteListType ------------- .. csv-table:: :header: "Name", "Description", "Schema" **route** *optional*, "", string .. _RoutingPolicyType-label: RoutingPolicyType ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **sequence** *optional*, "", string .. _BgpRouterParams-label: BgpRouterParams --------------- .. csv-table:: :header: "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-label: BgpPeeringAttributes -------------------- .. csv-table:: :header: "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-label: BgpSessionAttributes -------------------- .. csv-table:: :header: "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-label: AddressFamilies --------------- .. csv-table:: :header: "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-label: ServiceChainInfo ---------------- .. csv-table:: :header: "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-label: StaticRouteEntriesType ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **route** *optional*, "", `StaticRouteType`_ .. _ConnectionType-label: ConnectionType -------------- .. csv-table:: :header: "Name", "Description", "Schema" **destination_instance** *optional*, "", string .. _InstanceTargetType-label: InstanceTargetType ------------------ .. csv-table:: :header: "Name", "Description", "Schema" **import_export** *optional*, "", "Any of ['import', 'export']" .. _DefaultProtocolType-label: DefaultProtocolType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **bgp** *optional*, "", `ProtocolBgpType`_ **ospf** *optional*, "", `ProtocolOspfType`_ .. _PolicyStatementType-label: PolicyStatementType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **term** *optional*, "", `PolicyTermType`_ .. _FieldNamesList-label: FieldNamesList -------------- .. csv-table:: :header: "Name", "Description", "Schema" **field_names** *optional*, "", string .. _StructuredSyslogLinkmap-label: StructuredSyslogLinkmap ----------------------- .. csv-table:: :header: "Name", "Description", "Schema" **links** *optional*, "", `StructuredSyslogLinkType`_ .. _StructuredSyslogLANSegmentList-label: StructuredSyslogLANSegmentList ------------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **LANSegmentList** *optional*, "", `StructuredSyslogLANSegmentType`_ .. _StructuredSyslogDSCPMap-label: StructuredSyslogDSCPMap ----------------------- .. csv-table:: :header: "Name", "Description", "Schema" **dscpListIPv4** *optional*, "", `StructuredSyslogDSCPType`_ **dscpListIPv6** *optional*, "", `StructuredSyslogDSCPType`_ .. _AccessControlListCreate-label: AccessControlListCreate ----------------------- .. csv-table:: :header: "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-label: AccessControlListReadDetail --------------------------- .. csv-table:: :header: "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-label: AccessControlListReadAll ------------------------ .. csv-table:: :header: "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-label: AccessControlListUpdate ----------------------- .. csv-table:: :header: "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-label: AddressGroupCreate ------------------ .. csv-table:: :header: "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-label: AddressGroupReadDetail ---------------------- .. csv-table:: :header: "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-label: AddressGroupReadAll ------------------- .. csv-table:: :header: "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-label: AddressGroupUpdate ------------------ .. csv-table:: :header: "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-label: AlarmCreate ----------- .. csv-table:: :header: "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:, 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-label: AlarmReadDetail --------------- .. csv-table:: :header: "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:, 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-label: AlarmReadAll ------------ .. csv-table:: :header: "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:, 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-label: AlarmUpdate ----------- .. csv-table:: :header: "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:, 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-label: AliasIpCreate ------------- .. csv-table:: :header: "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-label: AliasIpReadDetail ----------------- .. csv-table:: :header: "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-label: AliasIpReadAll -------------- .. csv-table:: :header: "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-label: AliasIpUpdate ------------- .. csv-table:: :header: "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-label: AliasIpPoolCreate ----------------- .. csv-table:: :header: "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-label: AliasIpPoolReadDetail --------------------- .. csv-table:: :header: "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-label: AliasIpPoolReadAll ------------------ .. csv-table:: :header: "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-label: AliasIpPoolUpdate ----------------- .. csv-table:: :header: "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-label: AnalyticsAlarmNodeCreate ------------------------ .. csv-table:: :header: "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-label: AnalyticsAlarmNodeReadDetail ---------------------------- .. csv-table:: :header: "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-label: AnalyticsAlarmNodeReadAll ------------------------- .. csv-table:: :header: "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-label: AnalyticsAlarmNodeUpdate ------------------------ .. csv-table:: :header: "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-label: AnalyticsNodeCreate ------------------- .. csv-table:: :header: "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-label: AnalyticsNodeReadDetail ----------------------- .. csv-table:: :header: "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-label: AnalyticsNodeReadAll -------------------- .. csv-table:: :header: "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-label: AnalyticsNodeUpdate ------------------- .. csv-table:: :header: "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-label: AnalyticsSnmpNodeCreate ----------------------- .. csv-table:: :header: "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-label: AnalyticsSnmpNodeReadDetail --------------------------- .. csv-table:: :header: "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-label: AnalyticsSnmpNodeReadAll ------------------------ .. csv-table:: :header: "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-label: AnalyticsSnmpNodeUpdate ----------------------- .. csv-table:: :header: "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-label: ApiAccessListCreate ------------------- .. csv-table:: :header: "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-label: ApiAccessListReadDetail ----------------------- .. csv-table:: :header: "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-label: ApiAccessListReadAll -------------------- .. csv-table:: :header: "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-label: ApiAccessListUpdate ------------------- .. csv-table:: :header: "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-label: ApplicationPolicySetCreate -------------------------- .. csv-table:: :header: "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-label: ApplicationPolicySetReadDetail ------------------------------ .. csv-table:: :header: "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-label: ApplicationPolicySetReadAll --------------------------- .. csv-table:: :header: "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-label: ApplicationPolicySetUpdate -------------------------- .. csv-table:: :header: "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-label: BgpAsAServiceCreate ------------------- .. csv-table:: :header: "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-label: BgpAsAServiceReadDetail ----------------------- .. csv-table:: :header: "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-label: BgpAsAServiceReadAll -------------------- .. csv-table:: :header: "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-label: BgpAsAServiceUpdate ------------------- .. csv-table:: :header: "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-label: BgpRouterCreate --------------- .. csv-table:: :header: "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-label: BgpRouterReadDetail ------------------- .. csv-table:: :header: "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-label: BgpRouterReadAll ---------------- .. csv-table:: :header: "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-label: BgpRouterUpdate --------------- .. csv-table:: :header: "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-label: BgpvpnCreate ------------ .. csv-table:: :header: "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-label: BgpvpnReadDetail ---------------- .. csv-table:: :header: "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-label: BgpvpnReadAll ------------- .. csv-table:: :header: "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-label: BgpvpnUpdate ------------ .. csv-table:: :header: "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-label: BridgeDomainCreate ------------------ .. csv-table:: :header: "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-label: BridgeDomainReadDetail ---------------------- .. csv-table:: :header: "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-label: BridgeDomainReadAll ------------------- .. csv-table:: :header: "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-label: BridgeDomainUpdate ------------------ .. csv-table:: :header: "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-label: CardCreate ---------- .. csv-table:: :header: "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-label: CardReadDetail -------------- .. csv-table:: :header: "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-label: CardReadAll ----------- .. csv-table:: :header: "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-label: CardUpdate ---------- .. csv-table:: :header: "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-label: CliConfigCreate --------------- .. csv-table:: :header: "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-label: CliConfigReadDetail ------------------- .. csv-table:: :header: "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-label: CliConfigReadAll ---------------- .. csv-table:: :header: "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-label: CliConfigUpdate --------------- .. csv-table:: :header: "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-label: ConfigDatabaseNodeCreate ------------------------ .. csv-table:: :header: "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-label: ConfigDatabaseNodeReadDetail ---------------------------- .. csv-table:: :header: "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-label: ConfigDatabaseNodeReadAll ------------------------- .. csv-table:: :header: "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-label: ConfigDatabaseNodeUpdate ------------------------ .. csv-table:: :header: "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-label: ConfigNodeCreate ---------------- .. csv-table:: :header: "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-label: ConfigNodeReadDetail -------------------- .. csv-table:: :header: "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-label: ConfigNodeReadAll ----------------- .. csv-table:: :header: "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-label: ConfigNodeUpdate ---------------- .. csv-table:: :header: "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-label: ConfigPropertiesCreate ---------------------- .. csv-table:: :header: "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-label: ConfigPropertiesReadDetail -------------------------- .. csv-table:: :header: "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-label: ConfigPropertiesReadAll ----------------------- .. csv-table:: :header: "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-label: ConfigPropertiesUpdate ---------------------- .. csv-table:: :header: "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-label: ConfigRootCreate ---------------- .. csv-table:: :header: "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-label: ConfigRootReadDetail -------------------- .. csv-table:: :header: "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-label: ConfigRootReadAll ----------------- .. csv-table:: :header: "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-label: ConfigRootUpdate ---------------- .. csv-table:: :header: "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-label: ControlNodeZoneCreate --------------------- .. csv-table:: :header: "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-label: ControlNodeZoneReadDetail ------------------------- .. csv-table:: :header: "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-label: ControlNodeZoneReadAll ---------------------- .. csv-table:: :header: "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-label: ControlNodeZoneUpdate --------------------- .. csv-table:: :header: "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-label: CustomerAttachmentCreate ------------------------ .. csv-table:: :header: "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-label: CustomerAttachmentReadDetail ---------------------------- .. csv-table:: :header: "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-label: CustomerAttachmentReadAll ------------------------- .. csv-table:: :header: "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-label: CustomerAttachmentUpdate ------------------------ .. csv-table:: :header: "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-label: DataCenterInterconnectCreate ---------------------------- .. csv-table:: :header: "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-label: DataCenterInterconnectReadDetail -------------------------------- .. csv-table:: :header: "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-label: DataCenterInterconnectReadAll ----------------------------- .. csv-table:: :header: "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-label: DataCenterInterconnectUpdate ---------------------------- .. csv-table:: :header: "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-label: DatabaseNodeCreate ------------------ .. csv-table:: :header: "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-label: DatabaseNodeReadDetail ---------------------- .. csv-table:: :header: "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-label: DatabaseNodeReadAll ------------------- .. csv-table:: :header: "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-label: DatabaseNodeUpdate ------------------ .. csv-table:: :header: "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-label: DeviceChassisCreate ------------------- .. csv-table:: :header: "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-label: DeviceChassisReadDetail ----------------------- .. csv-table:: :header: "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-label: DeviceChassisReadAll -------------------- .. csv-table:: :header: "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-label: DeviceChassisUpdate ------------------- .. csv-table:: :header: "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-label: DeviceFunctionalGroupCreate --------------------------- .. csv-table:: :header: "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-label: DeviceFunctionalGroupReadDetail ------------------------------- .. csv-table:: :header: "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-label: DeviceFunctionalGroupReadAll ---------------------------- .. csv-table:: :header: "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-label: DeviceFunctionalGroupUpdate --------------------------- .. csv-table:: :header: "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-label: DeviceImageCreate ----------------- .. csv-table:: :header: "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-label: DeviceImageReadDetail --------------------- .. csv-table:: :header: "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-label: DeviceImageReadAll ------------------ .. csv-table:: :header: "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-label: DeviceImageUpdate ----------------- .. csv-table:: :header: "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-label: DevicemgrNodeCreate ------------------- .. csv-table:: :header: "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-label: DevicemgrNodeReadDetail ----------------------- .. csv-table:: :header: "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-label: DevicemgrNodeReadAll -------------------- .. csv-table:: :header: "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-label: DevicemgrNodeUpdate ------------------- .. csv-table:: :header: "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-label: DiscoveryServiceAssignmentCreate -------------------------------- .. csv-table:: :header: "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-label: DiscoveryServiceAssignmentReadDetail ------------------------------------ .. csv-table:: :header: "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-label: DiscoveryServiceAssignmentReadAll --------------------------------- .. csv-table:: :header: "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-label: DiscoveryServiceAssignmentUpdate -------------------------------- .. csv-table:: :header: "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-label: DomainCreate ------------ .. csv-table:: :header: "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-label: DomainReadDetail ---------------- .. csv-table:: :header: "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-label: DomainReadAll ------------- .. csv-table:: :header: "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-label: DomainUpdate ------------ .. csv-table:: :header: "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-label: DsaRuleCreate ------------- .. csv-table:: :header: "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-label: DsaRuleReadDetail ----------------- .. csv-table:: :header: "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-label: DsaRuleReadAll -------------- .. csv-table:: :header: "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-label: DsaRuleUpdate ------------- .. csv-table:: :header: "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-label: E2ServiceProviderCreate ----------------------- .. csv-table:: :header: "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-label: E2ServiceProviderReadDetail --------------------------- .. csv-table:: :header: "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-label: E2ServiceProviderReadAll ------------------------ .. csv-table:: :header: "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-label: E2ServiceProviderUpdate ----------------------- .. csv-table:: :header: "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-label: FabricCreate ------------ .. csv-table:: :header: "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-label: FabricReadDetail ---------------- .. csv-table:: :header: "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-label: FabricReadAll ------------- .. csv-table:: :header: "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-label: FabricUpdate ------------ .. csv-table:: :header: "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-label: FabricNamespaceCreate --------------------- .. csv-table:: :header: "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-label: FabricNamespaceReadDetail ------------------------- .. csv-table:: :header: "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-label: FabricNamespaceReadAll ---------------------- .. csv-table:: :header: "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-label: FabricNamespaceUpdate --------------------- .. csv-table:: :header: "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-label: FeatureCreate ------------- .. csv-table:: :header: "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-label: FeatureReadDetail ----------------- .. csv-table:: :header: "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-label: FeatureReadAll -------------- .. csv-table:: :header: "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-label: FeatureUpdate ------------- .. csv-table:: :header: "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-label: FeatureConfigCreate ------------------- .. csv-table:: :header: "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-label: FeatureConfigReadDetail ----------------------- .. csv-table:: :header: "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-label: FeatureConfigReadAll -------------------- .. csv-table:: :header: "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-label: FeatureConfigUpdate ------------------- .. csv-table:: :header: "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-label: FeatureFlagCreate ----------------- .. csv-table:: :header: "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-label: FeatureFlagReadDetail --------------------- .. csv-table:: :header: "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-label: FeatureFlagReadAll ------------------ .. csv-table:: :header: "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-label: FeatureFlagUpdate ----------------- .. csv-table:: :header: "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-label: FirewallPolicyCreate -------------------- .. csv-table:: :header: "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-label: FirewallPolicyReadDetail ------------------------ .. csv-table:: :header: "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-label: FirewallPolicyReadAll --------------------- .. csv-table:: :header: "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-label: FirewallPolicyUpdate -------------------- .. csv-table:: :header: "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-label: FirewallRuleCreate ------------------ .. csv-table:: :header: "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-label: FirewallRuleReadDetail ---------------------- .. csv-table:: :header: "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-label: FirewallRuleReadAll ------------------- .. csv-table:: :header: "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-label: FirewallRuleUpdate ------------------ .. csv-table:: :header: "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-label: FloatingIpCreate ---------------- .. csv-table:: :header: "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-label: FloatingIpReadDetail -------------------- .. csv-table:: :header: "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-label: FloatingIpReadAll ----------------- .. csv-table:: :header: "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-label: FloatingIpUpdate ---------------- .. csv-table:: :header: "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-label: FloatingIpPoolCreate -------------------- .. csv-table:: :header: "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-label: FloatingIpPoolReadDetail ------------------------ .. csv-table:: :header: "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-label: FloatingIpPoolReadAll --------------------- .. csv-table:: :header: "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-label: FloatingIpPoolUpdate -------------------- .. csv-table:: :header: "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-label: FlowNodeCreate -------------- .. csv-table:: :header: "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-label: FlowNodeReadDetail ------------------ .. csv-table:: :header: "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-label: FlowNodeReadAll --------------- .. csv-table:: :header: "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-label: FlowNodeUpdate -------------- .. csv-table:: :header: "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-label: ForwardingClassCreate --------------------- .. csv-table:: :header: "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-label: ForwardingClassReadDetail ------------------------- .. csv-table:: :header: "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-label: ForwardingClassReadAll ---------------------- .. csv-table:: :header: "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-label: ForwardingClassUpdate --------------------- .. csv-table:: :header: "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-label: GlobalAnalyticsConfigCreate --------------------------- .. csv-table:: :header: "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-label: GlobalAnalyticsConfigReadDetail ------------------------------- .. csv-table:: :header: "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-label: GlobalAnalyticsConfigReadAll ---------------------------- .. csv-table:: :header: "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-label: GlobalAnalyticsConfigUpdate --------------------------- .. csv-table:: :header: "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-label: GlobalQosConfigCreate --------------------- .. csv-table:: :header: "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-label: GlobalQosConfigReadDetail ------------------------- .. csv-table:: :header: "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-label: GlobalQosConfigReadAll ---------------------- .. csv-table:: :header: "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-label: GlobalQosConfigUpdate --------------------- .. csv-table:: :header: "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-label: GlobalSystemConfigCreate ------------------------ .. csv-table:: :header: "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 **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-label: GlobalSystemConfigReadDetail ---------------------------- .. csv-table:: :header: "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 **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-label: GlobalSystemConfigReadAll ------------------------- .. csv-table:: :header: "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 **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-label: GlobalSystemConfigUpdate ------------------------ .. csv-table:: :header: "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 **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-label: GlobalVrouterConfigCreate ------------------------- .. csv-table:: :header: "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-label: GlobalVrouterConfigReadDetail ----------------------------- .. csv-table:: :header: "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-label: GlobalVrouterConfigReadAll -------------------------- .. csv-table:: :header: "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-label: GlobalVrouterConfigUpdate ------------------------- .. csv-table:: :header: "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-label: GrpcProfileCreate ----------------- .. csv-table:: :header: "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-label: GrpcProfileReadDetail --------------------- .. csv-table:: :header: "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-label: GrpcProfileReadAll ------------------ .. csv-table:: :header: "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-label: GrpcProfileUpdate ----------------- .. csv-table:: :header: "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-label: HardwareCreate -------------- .. csv-table:: :header: "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-label: HardwareReadDetail ------------------ .. csv-table:: :header: "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-label: HardwareReadAll --------------- .. csv-table:: :header: "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-label: HardwareUpdate -------------- .. csv-table:: :header: "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-label: HardwareInventoryCreate ----------------------- .. csv-table:: :header: "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-label: HardwareInventoryReadDetail --------------------------- .. csv-table:: :header: "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-label: HardwareInventoryReadAll ------------------------ .. csv-table:: :header: "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-label: HardwareInventoryUpdate ----------------------- .. csv-table:: :header: "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-label: HostBasedServiceCreate ---------------------- .. csv-table:: :header: "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-label: HostBasedServiceReadDetail -------------------------- .. csv-table:: :header: "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-label: HostBasedServiceReadAll ----------------------- .. csv-table:: :header: "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-label: HostBasedServiceUpdate ---------------------- .. csv-table:: :header: "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-label: InstanceIpCreate ---------------- .. csv-table:: :header: "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-label: InstanceIpReadDetail -------------------- .. csv-table:: :header: "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-label: InstanceIpReadAll ----------------- .. csv-table:: :header: "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-label: InstanceIpUpdate ---------------- .. csv-table:: :header: "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-label: IntentMapCreate --------------- .. csv-table:: :header: "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-label: IntentMapReadDetail ------------------- .. csv-table:: :header: "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-label: IntentMapReadAll ---------------- .. csv-table:: :header: "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-label: IntentMapUpdate --------------- .. csv-table:: :header: "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-label: InterfaceRouteTableCreate ------------------------- .. csv-table:: :header: "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-label: InterfaceRouteTableReadDetail ----------------------------- .. csv-table:: :header: "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-label: InterfaceRouteTableReadAll -------------------------- .. csv-table:: :header: "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-label: InterfaceRouteTableUpdate ------------------------- .. csv-table:: :header: "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-label: JobTemplateCreate ----------------- .. csv-table:: :header: "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-label: JobTemplateReadDetail --------------------- .. csv-table:: :header: "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-label: JobTemplateReadAll ------------------ .. csv-table:: :header: "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-label: JobTemplateUpdate ----------------- .. csv-table:: :header: "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-label: LinkAggregationGroupCreate -------------------------- .. csv-table:: :header: "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-label: LinkAggregationGroupReadDetail ------------------------------ .. csv-table:: :header: "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-label: LinkAggregationGroupReadAll --------------------------- .. csv-table:: :header: "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-label: LinkAggregationGroupUpdate -------------------------- .. csv-table:: :header: "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-label: LoadbalancerCreate ------------------ .. csv-table:: :header: "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-label: LoadbalancerReadDetail ---------------------- .. csv-table:: :header: "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-label: LoadbalancerReadAll ------------------- .. csv-table:: :header: "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-label: LoadbalancerUpdate ------------------ .. csv-table:: :header: "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-label: LoadbalancerHealthmonitorCreate ------------------------------- .. csv-table:: :header: "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-label: LoadbalancerHealthmonitorReadDetail ----------------------------------- .. csv-table:: :header: "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-label: LoadbalancerHealthmonitorReadAll -------------------------------- .. csv-table:: :header: "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-label: LoadbalancerHealthmonitorUpdate ------------------------------- .. csv-table:: :header: "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-label: LoadbalancerListenerCreate -------------------------- .. csv-table:: :header: "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-label: LoadbalancerListenerReadDetail ------------------------------ .. csv-table:: :header: "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-label: LoadbalancerListenerReadAll --------------------------- .. csv-table:: :header: "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-label: LoadbalancerListenerUpdate -------------------------- .. csv-table:: :header: "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-label: LoadbalancerMemberCreate ------------------------ .. csv-table:: :header: "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-label: LoadbalancerMemberReadDetail ---------------------------- .. csv-table:: :header: "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-label: LoadbalancerMemberReadAll ------------------------- .. csv-table:: :header: "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-label: LoadbalancerMemberUpdate ------------------------ .. csv-table:: :header: "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-label: LoadbalancerPoolCreate ---------------------- .. csv-table:: :header: "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-label: LoadbalancerPoolReadDetail -------------------------- .. csv-table:: :header: "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-label: LoadbalancerPoolReadAll ----------------------- .. csv-table:: :header: "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-label: LoadbalancerPoolUpdate ---------------------- .. csv-table:: :header: "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-label: LogicalInterfaceCreate ---------------------- .. csv-table:: :header: "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-label: LogicalInterfaceReadDetail -------------------------- .. csv-table:: :header: "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-label: LogicalInterfaceReadAll ----------------------- .. csv-table:: :header: "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-label: LogicalInterfaceUpdate ---------------------- .. csv-table:: :header: "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-label: LogicalRouterCreate ------------------- .. csv-table:: :header: "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-label: LogicalRouterReadDetail ----------------------- .. csv-table:: :header: "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-label: LogicalRouterReadAll -------------------- .. csv-table:: :header: "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-label: LogicalRouterUpdate ------------------- .. csv-table:: :header: "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-label: MulticastPolicyCreate --------------------- .. csv-table:: :header: "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-label: MulticastPolicyReadDetail ------------------------- .. csv-table:: :header: "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-label: MulticastPolicyReadAll ---------------------- .. csv-table:: :header: "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-label: MulticastPolicyUpdate --------------------- .. csv-table:: :header: "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-label: NamespaceCreate --------------- .. csv-table:: :header: "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-label: NamespaceReadDetail ------------------- .. csv-table:: :header: "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-label: NamespaceReadAll ---------------- .. csv-table:: :header: "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-label: NamespaceUpdate --------------- .. csv-table:: :header: "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-label: NetconfProfileCreate -------------------- .. csv-table:: :header: "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-label: NetconfProfileReadDetail ------------------------ .. csv-table:: :header: "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-label: NetconfProfileReadAll --------------------- .. csv-table:: :header: "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-label: NetconfProfileUpdate -------------------- .. csv-table:: :header: "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-label: NetworkDeviceConfigCreate ------------------------- .. csv-table:: :header: "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-label: NetworkDeviceConfigReadDetail ----------------------------- .. csv-table:: :header: "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-label: NetworkDeviceConfigReadAll -------------------------- .. csv-table:: :header: "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-label: NetworkDeviceConfigUpdate ------------------------- .. csv-table:: :header: "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-label: NetworkIpamCreate ----------------- .. csv-table:: :header: "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-label: NetworkIpamReadDetail --------------------- .. csv-table:: :header: "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-label: NetworkIpamReadAll ------------------ .. csv-table:: :header: "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-label: NetworkIpamUpdate ----------------- .. csv-table:: :header: "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-label: NetworkPolicyCreate ------------------- .. csv-table:: :header: "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-label: NetworkPolicyReadDetail ----------------------- .. csv-table:: :header: "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-label: NetworkPolicyReadAll -------------------- .. csv-table:: :header: "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-label: NetworkPolicyUpdate ------------------- .. csv-table:: :header: "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-label: NodeCreate ---------- .. csv-table:: :header: "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-label: NodeReadDetail -------------- .. csv-table:: :header: "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-label: NodeReadAll ----------- .. csv-table:: :header: "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-label: NodeUpdate ---------- .. csv-table:: :header: "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-label: NodeProfileCreate ----------------- .. csv-table:: :header: "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-label: NodeProfileReadDetail --------------------- .. csv-table:: :header: "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-label: NodeProfileReadAll ------------------ .. csv-table:: :header: "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-label: NodeProfileUpdate ----------------- .. csv-table:: :header: "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-label: OverlayRoleCreate ----------------- .. csv-table:: :header: "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-label: OverlayRoleReadDetail --------------------- .. csv-table:: :header: "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-label: OverlayRoleReadAll ------------------ .. csv-table:: :header: "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-label: OverlayRoleUpdate ----------------- .. csv-table:: :header: "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-label: PeeringPolicyCreate ------------------- .. csv-table:: :header: "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-label: PeeringPolicyReadDetail ----------------------- .. csv-table:: :header: "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-label: PeeringPolicyReadAll -------------------- .. csv-table:: :header: "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-label: PeeringPolicyUpdate ------------------- .. csv-table:: :header: "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-label: PhysicalInterfaceCreate ----------------------- .. csv-table:: :header: "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-label: PhysicalInterfaceReadDetail --------------------------- .. csv-table:: :header: "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-label: PhysicalInterfaceReadAll ------------------------ .. csv-table:: :header: "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-label: PhysicalInterfaceUpdate ----------------------- .. csv-table:: :header: "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-label: PhysicalRoleCreate ------------------ .. csv-table:: :header: "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-label: PhysicalRoleReadDetail ---------------------- .. csv-table:: :header: "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-label: PhysicalRoleReadAll ------------------- .. csv-table:: :header: "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-label: PhysicalRoleUpdate ------------------ .. csv-table:: :header: "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-label: PhysicalRouterCreate -------------------- .. csv-table:: :header: "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-label: PhysicalRouterReadDetail ------------------------ .. csv-table:: :header: "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-label: PhysicalRouterReadAll --------------------- .. csv-table:: :header: "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-label: PhysicalRouterUpdate -------------------- .. csv-table:: :header: "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-label: PolicyManagementCreate ---------------------- .. csv-table:: :header: "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-label: PolicyManagementReadDetail -------------------------- .. csv-table:: :header: "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-label: PolicyManagementReadAll ----------------------- .. csv-table:: :header: "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-label: PolicyManagementUpdate ---------------------- .. csv-table:: :header: "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-label: PortCreate ---------- .. csv-table:: :header: "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-label: PortReadDetail -------------- .. csv-table:: :header: "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-label: PortReadAll ----------- .. csv-table:: :header: "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-label: PortUpdate ---------- .. csv-table:: :header: "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-label: PortGroupCreate --------------- .. csv-table:: :header: "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-label: PortGroupReadDetail ------------------- .. csv-table:: :header: "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-label: PortGroupReadAll ---------------- .. csv-table:: :header: "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-label: PortGroupUpdate --------------- .. csv-table:: :header: "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-label: PortProfileCreate ----------------- .. csv-table:: :header: "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-label: PortProfileReadDetail --------------------- .. csv-table:: :header: "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-label: PortProfileReadAll ------------------ .. csv-table:: :header: "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-label: PortProfileUpdate ----------------- .. csv-table:: :header: "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-label: PortTupleCreate --------------- .. csv-table:: :header: "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-label: PortTupleReadDetail ------------------- .. csv-table:: :header: "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-label: PortTupleReadAll ---------------- .. csv-table:: :header: "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-label: PortTupleUpdate --------------- .. csv-table:: :header: "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-label: ProjectCreate ------------- .. csv-table:: :header: "Name", "Description", "Schema" **fq_name** *required*, "Fully Qualified Name of resource", "< string > array" **parent_type** *required*, "Parent resource type", "Any of ['domain']" **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-label: ProjectReadDetail ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **fq_name** *required*, "Fully Qualified Name of resource", "< string > array" **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-label: ProjectReadAll -------------- .. csv-table:: :header: "Name", "Description", "Schema" **fq_name** *required*, "Fully Qualified Name of resource", "< string > array" **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-label: ProjectUpdate ------------- .. csv-table:: :header: "Name", "Description", "Schema" **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-label: ProviderAttachmentCreate ------------------------ .. csv-table:: :header: "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-label: ProviderAttachmentReadDetail ---------------------------- .. csv-table:: :header: "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-label: ProviderAttachmentReadAll ------------------------- .. csv-table:: :header: "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-label: ProviderAttachmentUpdate ------------------------ .. csv-table:: :header: "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-label: QosConfigCreate --------------- .. csv-table:: :header: "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-label: QosConfigReadDetail ------------------- .. csv-table:: :header: "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-label: QosConfigReadAll ---------------- .. csv-table:: :header: "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-label: QosConfigUpdate --------------- .. csv-table:: :header: "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-label: QosQueueCreate -------------- .. csv-table:: :header: "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-label: QosQueueReadDetail ------------------ .. csv-table:: :header: "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-label: QosQueueReadAll --------------- .. csv-table:: :header: "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-label: QosQueueUpdate -------------- .. csv-table:: :header: "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-label: RoleConfigCreate ---------------- .. csv-table:: :header: "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-label: RoleConfigReadDetail -------------------- .. csv-table:: :header: "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-label: RoleConfigReadAll ----------------- .. csv-table:: :header: "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-label: RoleConfigUpdate ---------------- .. csv-table:: :header: "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-label: RoleDefinitionCreate -------------------- .. csv-table:: :header: "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-label: RoleDefinitionReadDetail ------------------------ .. csv-table:: :header: "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-label: RoleDefinitionReadAll --------------------- .. csv-table:: :header: "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-label: RoleDefinitionUpdate -------------------- .. csv-table:: :header: "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-label: RouteAggregateCreate -------------------- .. csv-table:: :header: "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-label: RouteAggregateReadDetail ------------------------ .. csv-table:: :header: "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-label: RouteAggregateReadAll --------------------- .. csv-table:: :header: "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-label: RouteAggregateUpdate -------------------- .. csv-table:: :header: "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-label: RouteTableCreate ---------------- .. csv-table:: :header: "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-label: RouteTableReadDetail -------------------- .. csv-table:: :header: "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-label: RouteTableReadAll ----------------- .. csv-table:: :header: "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-label: RouteTableUpdate ---------------- .. csv-table:: :header: "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-label: RouteTargetCreate ----------------- .. csv-table:: :header: "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-label: RouteTargetReadDetail --------------------- .. csv-table:: :header: "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-label: RouteTargetReadAll ------------------ .. csv-table:: :header: "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-label: RouteTargetUpdate ----------------- .. csv-table:: :header: "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-label: RoutingInstanceCreate --------------------- .. csv-table:: :header: "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 **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-label: RoutingInstanceReadDetail ------------------------- .. csv-table:: :header: "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 **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-label: RoutingInstanceReadAll ---------------------- .. csv-table:: :header: "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 **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-label: RoutingInstanceUpdate --------------------- .. csv-table:: :header: "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-label: RoutingPolicyCreate ------------------- .. csv-table:: :header: "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-label: RoutingPolicyReadDetail ----------------------- .. csv-table:: :header: "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-label: RoutingPolicyReadAll -------------------- .. csv-table:: :header: "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-label: RoutingPolicyUpdate ------------------- .. csv-table:: :header: "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-label: SecurityGroupCreate ------------------- .. csv-table:: :header: "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-label: SecurityGroupReadDetail ----------------------- .. csv-table:: :header: "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-label: SecurityGroupReadAll -------------------- .. csv-table:: :header: "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-label: SecurityGroupUpdate ------------------- .. csv-table:: :header: "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-label: SecurityLoggingObjectCreate --------------------------- .. csv-table:: :header: "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-label: SecurityLoggingObjectReadDetail ------------------------------- .. csv-table:: :header: "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-label: SecurityLoggingObjectReadAll ---------------------------- .. csv-table:: :header: "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-label: SecurityLoggingObjectUpdate --------------------------- .. csv-table:: :header: "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-label: ServiceApplianceCreate ---------------------- .. csv-table:: :header: "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-label: ServiceApplianceReadDetail -------------------------- .. csv-table:: :header: "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-label: ServiceApplianceReadAll ----------------------- .. csv-table:: :header: "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-label: ServiceApplianceUpdate ---------------------- .. csv-table:: :header: "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-label: ServiceApplianceSetCreate ------------------------- .. csv-table:: :header: "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-label: ServiceApplianceSetReadDetail ----------------------------- .. csv-table:: :header: "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-label: ServiceApplianceSetReadAll -------------------------- .. csv-table:: :header: "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-label: ServiceApplianceSetUpdate ------------------------- .. csv-table:: :header: "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-label: ServiceConnectionModuleCreate ----------------------------- .. csv-table:: :header: "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-label: ServiceConnectionModuleReadDetail --------------------------------- .. csv-table:: :header: "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-label: ServiceConnectionModuleReadAll ------------------------------ .. csv-table:: :header: "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-label: ServiceConnectionModuleUpdate ----------------------------- .. csv-table:: :header: "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-label: ServiceEndpointCreate --------------------- .. csv-table:: :header: "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-label: ServiceEndpointReadDetail ------------------------- .. csv-table:: :header: "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-label: ServiceEndpointReadAll ---------------------- .. csv-table:: :header: "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-label: ServiceEndpointUpdate --------------------- .. csv-table:: :header: "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-label: ServiceGroupCreate ------------------ .. csv-table:: :header: "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-label: ServiceGroupReadDetail ---------------------- .. csv-table:: :header: "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-label: ServiceGroupReadAll ------------------- .. csv-table:: :header: "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-label: ServiceGroupUpdate ------------------ .. csv-table:: :header: "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-label: ServiceHealthCheckCreate ------------------------ .. csv-table:: :header: "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-label: ServiceHealthCheckReadDetail ---------------------------- .. csv-table:: :header: "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-label: ServiceHealthCheckReadAll ------------------------- .. csv-table:: :header: "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-label: ServiceHealthCheckUpdate ------------------------ .. csv-table:: :header: "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-label: ServiceInstanceCreate --------------------- .. csv-table:: :header: "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-label: ServiceInstanceReadDetail ------------------------- .. csv-table:: :header: "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-label: ServiceInstanceReadAll ---------------------- .. csv-table:: :header: "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-label: ServiceInstanceUpdate --------------------- .. csv-table:: :header: "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-label: ServiceObjectCreate ------------------- .. csv-table:: :header: "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-label: ServiceObjectReadDetail ----------------------- .. csv-table:: :header: "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-label: ServiceObjectReadAll -------------------- .. csv-table:: :header: "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-label: ServiceObjectUpdate ------------------- .. csv-table:: :header: "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-label: ServiceTemplateCreate --------------------- .. csv-table:: :header: "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-label: ServiceTemplateReadDetail ------------------------- .. csv-table:: :header: "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-label: ServiceTemplateReadAll ---------------------- .. csv-table:: :header: "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-label: ServiceTemplateUpdate --------------------- .. csv-table:: :header: "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-label: SflowProfileCreate ------------------ .. csv-table:: :header: "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-label: SflowProfileReadDetail ---------------------- .. csv-table:: :header: "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-label: SflowProfileReadAll ------------------- .. csv-table:: :header: "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-label: SflowProfileUpdate ------------------ .. csv-table:: :header: "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-label: SnmpProfileCreate ----------------- .. csv-table:: :header: "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-label: SnmpProfileReadDetail --------------------- .. csv-table:: :header: "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-label: SnmpProfileReadAll ------------------ .. csv-table:: :header: "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-label: SnmpProfileUpdate ----------------- .. csv-table:: :header: "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-label: StormControlProfileCreate ------------------------- .. csv-table:: :header: "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-label: StormControlProfileReadDetail ----------------------------- .. csv-table:: :header: "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-label: StormControlProfileReadAll -------------------------- .. csv-table:: :header: "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-label: StormControlProfileUpdate ------------------------- .. csv-table:: :header: "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-label: StructuredSyslogApplicationRecordCreate --------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogApplicationRecordReadDetail ------------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogApplicationRecordReadAll ---------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogApplicationRecordUpdate --------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogConfigCreate ---------------------------- .. csv-table:: :header: "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-label: StructuredSyslogConfigReadDetail -------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogConfigReadAll ----------------------------- .. csv-table:: :header: "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-label: StructuredSyslogConfigUpdate ---------------------------- .. csv-table:: :header: "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-label: StructuredSyslogHostnameRecordCreate ------------------------------------ .. csv-table:: :header: "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-label: StructuredSyslogHostnameRecordReadDetail ---------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogHostnameRecordReadAll ------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogHostnameRecordUpdate ------------------------------------ .. csv-table:: :header: "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-label: StructuredSyslogMessageCreate ----------------------------- .. csv-table:: :header: "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-label: StructuredSyslogMessageReadDetail --------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogMessageReadAll ------------------------------ .. csv-table:: :header: "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-label: StructuredSyslogMessageUpdate ----------------------------- .. csv-table:: :header: "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-label: StructuredSyslogSlaProfileCreate -------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogSlaProfileReadDetail ------------------------------------ .. csv-table:: :header: "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-label: StructuredSyslogSlaProfileReadAll --------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogSlaProfileUpdate -------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogTenantRecordCreate ---------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogTenantRecordReadDetail -------------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogTenantRecordReadAll ----------------------------------- .. csv-table:: :header: "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-label: StructuredSyslogTenantRecordUpdate ---------------------------------- .. csv-table:: :header: "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-label: SubClusterCreate ---------------- .. csv-table:: :header: "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-label: SubClusterReadDetail -------------------- .. csv-table:: :header: "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-label: SubClusterReadAll ----------------- .. csv-table:: :header: "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-label: SubClusterUpdate ---------------- .. csv-table:: :header: "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-label: SubnetCreate ------------ .. csv-table:: :header: "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-label: SubnetReadDetail ---------------- .. csv-table:: :header: "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-label: SubnetReadAll ------------- .. csv-table:: :header: "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-label: SubnetUpdate ------------ .. csv-table:: :header: "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-label: TagCreate --------- .. csv-table:: :header: "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-label: TagReadDetail ------------- .. csv-table:: :header: "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-label: TagReadAll ---------- .. csv-table:: :header: "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-label: TagUpdate --------- .. csv-table:: :header: "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-label: TagTypeCreate ------------- .. csv-table:: :header: "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-label: TagTypeReadDetail ----------------- .. csv-table:: :header: "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-label: TagTypeReadAll -------------- .. csv-table:: :header: "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-label: TagTypeUpdate ------------- .. csv-table:: :header: "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-label: TelemetryProfileCreate ---------------------- .. csv-table:: :header: "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-label: TelemetryProfileReadDetail -------------------------- .. csv-table:: :header: "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-label: TelemetryProfileReadAll ----------------------- .. csv-table:: :header: "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-label: TelemetryProfileUpdate ---------------------- .. csv-table:: :header: "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-label: VirtualDnsCreate ---------------- .. csv-table:: :header: "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-label: VirtualDnsReadDetail -------------------- .. csv-table:: :header: "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-label: VirtualDnsReadAll ----------------- .. csv-table:: :header: "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-label: VirtualDnsUpdate ---------------- .. csv-table:: :header: "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-label: VirtualDnsRecordCreate ---------------------- .. csv-table:: :header: "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-label: VirtualDnsRecordReadDetail -------------------------- .. csv-table:: :header: "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-label: VirtualDnsRecordReadAll ----------------------- .. csv-table:: :header: "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-label: VirtualDnsRecordUpdate ---------------------- .. csv-table:: :header: "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-label: VirtualIpCreate --------------- .. csv-table:: :header: "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-label: VirtualIpReadDetail ------------------- .. csv-table:: :header: "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-label: VirtualIpReadAll ---------------- .. csv-table:: :header: "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-label: VirtualIpUpdate --------------- .. csv-table:: :header: "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-label: VirtualMachineCreate -------------------- .. csv-table:: :header: "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-label: VirtualMachineReadDetail ------------------------ .. csv-table:: :header: "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-label: VirtualMachineReadAll --------------------- .. csv-table:: :header: "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-label: VirtualMachineUpdate -------------------- .. csv-table:: :header: "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-label: VirtualMachineInterfaceCreate ----------------------------- .. csv-table:: :header: "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-label: VirtualMachineInterfaceReadDetail --------------------------------- .. csv-table:: :header: "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-label: VirtualMachineInterfaceReadAll ------------------------------ .. csv-table:: :header: "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-label: VirtualMachineInterfaceUpdate ----------------------------- .. csv-table:: :header: "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-label: VirtualNetworkCreate -------------------- .. csv-table:: :header: "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-label: VirtualNetworkReadDetail ------------------------ .. csv-table:: :header: "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-label: VirtualNetworkReadAll --------------------- .. csv-table:: :header: "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-label: VirtualNetworkUpdate -------------------- .. csv-table:: :header: "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-label: VirtualPortGroupCreate ---------------------- .. csv-table:: :header: "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-label: VirtualPortGroupReadDetail -------------------------- .. csv-table:: :header: "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-label: VirtualPortGroupReadAll ----------------------- .. csv-table:: :header: "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-label: VirtualPortGroupUpdate ---------------------- .. csv-table:: :header: "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-label: VirtualRouterCreate ------------------- .. csv-table:: :header: "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-label: VirtualRouterReadDetail ----------------------- .. csv-table:: :header: "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-label: VirtualRouterReadAll -------------------- .. csv-table:: :header: "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-label: VirtualRouterUpdate ------------------- .. csv-table:: :header: "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-label: WebuiNodeCreate --------------- .. csv-table:: :header: "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-label: WebuiNodeReadDetail ------------------- .. csv-table:: :header: "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-label: WebuiNodeReadAll ---------------- .. csv-table:: :header: "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-label: WebuiNodeUpdate --------------- .. csv-table:: :header: "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-label: AlarmAndList ------------ .. csv-table:: :header: "Name", "Description", "Schema" **and_list** *optional*, "", `AlarmExpression`_ .. _UserDefinedLogStat-label: UserDefinedLogStat ------------------ .. csv-table:: :header: "Name", "Description", "Schema" **name** *required*, "Name of the stat", string **pattern** *required*, "Perl type regular expression pattern to match", string .. _ServicePropertiesType-label: ServicePropertiesType --------------------- .. csv-table:: :header: "Name", "Description", "Schema" **retain_as_path** *optional*, "Indicates if as-path should be retained across service-instances in the service- chain", boolean .. _LogicalRouterPRListParams-label: LogicalRouterPRListParams ------------------------- .. csv-table:: :header: "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-label: ServiceAppliancePhysicalInterfaceRefs ------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ServiceApplianceInterfaceType`_ .. _StructuredSyslogLinkType-label: StructuredSyslogLinkType ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **overlay** *optional*, "", string **underlay** *optional*, "", string **link_type** *optional*, "", string **traffic_destination** *optional*, "", string **metadata** *optional*, "", string .. _StructuredSyslogDSCPType-label: StructuredSyslogDSCPType ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **dscp_value** *optional*, "", string **alias_code** *optional*, "", string .. _VirtualRouterNetworkIpamRefs-label: VirtualRouterNetworkIpamRefs ---------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `VirtualRouterNetworkIpamType`_ .. _PortInfoType-label: PortInfoType ------------ .. csv-table:: :header: "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-label: PolicyRuleType -------------- .. csv-table:: :header: "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-label: AddressType ----------- .. csv-table:: :header: "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-label: FabricVirtualNetworkRefs ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `FabricNetworkTag`_ .. _ApplicationPolicySetFirewallPolicyRefs-label: ApplicationPolicySetFirewallPolicyRefs -------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `FirewallSequence`_ .. _PolicyTermType-label: PolicyTermType -------------- .. csv-table:: :header: "Name", "Description", "Schema" **term_match_condition** *optional*, "", `TermMatchConditionType`_ **term_action_list** *optional*, "", `TermActionListType`_ .. _IpamDnsAddressType-label: IpamDnsAddressType ------------------ .. csv-table:: :header: "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-label: TimerType --------- .. csv-table:: :header: "Name", "Description", "Schema" **start_time** *required*, "", string **on_interval** *required*, "", string **off_interval** *required*, "", string **end_time** *required*, "", string .. _FabricNodeProfileRefs-label: FabricNodeProfileRefs --------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `SerialNumListType`_ .. _LocalLinkConnection-label: LocalLinkConnection ------------------- .. csv-table:: :header: "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-label: PluginProperty -------------- .. csv-table:: :header: "Name", "Description", "Schema" **property** *optional*, "", string **value** *optional*, "", string .. _StaticRouteType-label: StaticRouteType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **prefix** *optional*, "", string **next_hop** *optional*, "", string **route_target** *optional*, "", string **community** *optional*, "", string .. _MirrorActionType-label: MirrorActionType ---------------- .. csv-table:: :header: "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-label: ServiceInstanceInterfaceType ---------------------------- .. csv-table:: :header: "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-label: StatsCollectionFrequency ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **sample_rate** *optional*, "", integer **polling_interval** *optional*, "", integer **direction** *optional*, "", "Any of ['ingress', 'egress']" .. _SecurityLoggingObjectSecurityGroupRefs-label: SecurityLoggingObjectSecurityGroupRefs -------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `SecurityLoggingObjectRuleListType`_ .. _RoutingInstanceRoutingInstanceRefs-label: RoutingInstanceRoutingInstanceRefs ---------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ConnectionType`_ .. _AclRuleType-label: AclRuleType ----------- .. csv-table:: :header: "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-label: RoutingInstanceRouteTargetRefs ------------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `InstanceTargetType`_ .. _QosIdForwardingClassPair-label: QosIdForwardingClassPair ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **key** *optional*, "QoS bit value (DSCP or Vlan priority or EXP bit value", integer **forwarding_class_id** *optional*, "", integer .. _PortTranslationPool-label: PortTranslationPool ------------------- .. csv-table:: :header: "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-label: ProtocolOspfType ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **area** *optional*, "", integer .. _PortMap-label: PortMap ------- .. csv-table:: :header: "Name", "Description", "Schema" **protocol** *optional*, "", string **src_port** *optional*, "", integer **dst_port** *optional*, "", integer .. _TermMatchConditionType-label: TermMatchConditionType ---------------------- .. csv-table:: :header: "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-label: DriverInfo ---------- .. csv-table:: :header: "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-label: VirtualMachineInterfaceRoutingInstanceRefs ------------------------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `PolicyBasedForwardingRuleType`_ .. _VrfAssignRuleType-label: VrfAssignRuleType ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **match_condition** *optional*, "", `MatchConditionType`_ **vlan_tag** *optional*, "", integer **routing_instance** *optional*, "", string **ignore_acl** *optional*, "", boolean .. _EnabledInterfaceParams-label: EnabledInterfaceParams ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **name** *optional*, "", string **stats_collection_frequency** *optional*, "", `StatsCollectionFrequency`_ .. _PortType-label: PortType -------- .. csv-table:: :header: "Name", "Description", "Schema" **start_port** *required*, "", integer **end_port** *required*, "", integer .. _SequenceType-label: SequenceType ------------ .. csv-table:: :header: "Name", "Description", "Schema" **major** *required*, "", integer **minor** *required*, "", integer .. _AllocationPoolType-label: AllocationPoolType ------------------ .. csv-table:: :header: "Name", "Description", "Schema" **start** *optional*, "", string **end** *optional*, "", string **vrouter_specific_pool** *optional*, "", boolean .. _VirtualNetworkRoutingPolicyRefs-label: VirtualNetworkRoutingPolicyRefs ------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `RoutingPolicyType`_ .. _ProtocolType-label: ProtocolType ------------ .. csv-table:: :header: "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-label: EnabledSensorParams ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **physical_health** *optional*, "", boolean **interface_health** *optional*, "", boolean **control_plane_health** *optional*, "", boolean **service_layer_health** *optional*, "", boolean .. _BgpRouterBgpRouterRefs-label: BgpRouterBgpRouterRefs ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `BgpPeeringAttributes`_ .. _LacpParams-label: LacpParams ---------- .. csv-table:: :header: "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-label: RoutedProperties ---------------- .. csv-table:: :header: "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-label: FirewallPolicyFirewallRuleRefs ------------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `FirewallSequence`_ .. _LogicalRouterVirtualNetworkRefs-label: LogicalRouterVirtualNetworkRefs ------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `LogicalRouterVirtualNetworkType`_ .. _OspfParameters-label: OspfParameters -------------- .. csv-table:: :header: "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-label: RouteType --------- .. csv-table:: :header: "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-label: VirtualMachineInterfaceVirtualPortGroupRefs ------------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `VMIVirtualPortGroupAttributes`_ .. _ServiceScaleOutType-label: ServiceScaleOutType ------------------- .. csv-table:: :header: "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-label: PermType2 --------- .. csv-table:: :header: "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-label: ExecutableInfoType ------------------ .. csv-table:: :header: "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-label: SecurityLoggingObjectRuleEntryType ---------------------------------- .. csv-table:: :header: "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-label: SecurityLoggingObjectNetworkPolicyRefs -------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `SecurityLoggingObjectRuleListType`_ .. _HostBasedServiceVirtualNetworkRefs-label: HostBasedServiceVirtualNetworkRefs ---------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ServiceVirtualNetworkType`_ .. _AllowedAddressPair-label: AllowedAddressPair ------------------ .. csv-table:: :header: "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-label: IdPermsType ----------- .. csv-table:: :header: "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-label: KeyValuePair ------------ .. csv-table:: :header: "Name", "Description", "Schema" **key** *optional*, "", string **value** *optional*, "", string .. _FlowAgingTimeout-label: FlowAgingTimeout ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **protocol** *optional*, "", string **port** *optional*, "", integer **timeout_in_seconds** *optional*, "", integer .. _VirtualNetworkNetworkPolicyRefs-label: VirtualNetworkNetworkPolicyRefs ------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `VirtualNetworkPolicyType`_ .. _DhcpOptionType-label: DhcpOptionType -------------- .. csv-table:: :header: "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-label: PlaybookInfoType ---------------- .. csv-table:: :header: "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-label: InterfaceMirrorType ------------------- .. csv-table:: :header: "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-label: AlarmExpression --------------- .. csv-table:: :header: "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-label: DnsSoaRecordType ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **negative_cache_ttl_seconds** *optional*, "Default Time To Live for negative caching of DNS queries", integer .. _BgpSession-label: BgpSession ---------- .. csv-table:: :header: "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-label: BgpAsAServiceControlNodeZoneRefs -------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `BGPaaSControlNodeZoneAttributes`_ .. _BaremetalProperties-label: BaremetalProperties ------------------- .. csv-table:: :header: "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-label: PortGroupProperties ------------------- .. csv-table:: :header: "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-label: ShareType --------- .. csv-table:: :header: "Name", "Description", "Schema" **tenant** *required*, "Name of tenant with whom the object is shared", string **tenant_access** *required*, "Allowed permissions in sharing", integer .. _DeviceCredential-label: DeviceCredential ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **credential** *required*, "", `UserCredentials`_ **vendor** *optional*, "", string **device_family** *optional*, "", string .. _RouteOriginOverride-label: RouteOriginOverride ------------------- .. csv-table:: :header: "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-label: TelemetryResourceInfo --------------------- .. csv-table:: :header: "Name", "Description", "Schema" **name** *optional*, "", string **path** *optional*, "", string **rate** *optional*, "", string .. _ResourceReference-label: ResourceReference ----------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" .. _MatchConditionType-label: MatchConditionType ------------------ .. csv-table:: :header: "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-label: CliDiffInfoType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **username** *optional*, "", string **time** *optional*, "", string **config_changes** *optional*, "", string .. _RbacRuleType-label: RbacRuleType ------------ .. csv-table:: :header: "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-label: TermActionListType ------------------ .. csv-table:: :header: "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-label: VirtualMachineInterfaceBridgeDomainRefs --------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `BridgeDomainMembershipType`_ .. _IpamSubnetType-label: IpamSubnetType -------------- .. csv-table:: :header: "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-label: NodeProfileRoleType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **physical_role** *optional*, "", string **rb_roles** *optional*, "", string .. _ProjectNamespaceRefs-label: ProjectNamespaceRefs -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `SubnetType`_ .. _PimParameters-label: PimParameters ------------- .. csv-table:: :header: "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-label: BgpFamilyAttributes ------------------- .. csv-table:: :header: "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-label: VirtualPortGroupPhysicalInterfaceRefs ------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `VpgInterfaceParametersType`_ .. _EncryptionTunnelEndpoint-label: EncryptionTunnelEndpoint ------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **tunnel_remote_ip_address** *required*, "Tunnel endpoint remote address", string .. _FirewallPolicySecurityLoggingObjectRefs-label: FirewallPolicySecurityLoggingObjectRefs --------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `SloRateType`_ .. _ProtocolBgpType-label: ProtocolBgpType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **autonomous_system** *optional*, "", integer .. _ServiceHealthCheckServiceInstanceRefs-label: ServiceHealthCheckServiceInstanceRefs ------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ServiceInterfaceTag`_ .. _DiscoveryPubSubEndPointType-label: DiscoveryPubSubEndPointType --------------------------- .. csv-table:: :header: "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-label: StructuredSyslogLANSegmentType ------------------------------ .. csv-table:: :header: "Name", "Description", "Schema" **vpn** *optional*, "", string **network_ranges** *optional*, "", string .. _VirtualNetworkNetworkIpamRefs-label: VirtualNetworkNetworkIpamRefs ----------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `VnSubnetsType`_ .. _UuidType-label: UuidType -------- .. csv-table:: :header: "Name", "Description", "Schema" **uuid_mslong** *optional*, "", number **uuid_lslong** *optional*, "", number .. _RoutingPolicyServiceInstanceRefs-label: RoutingPolicyServiceInstanceRefs -------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `RoutingPolicyServiceInstanceType`_ .. _AuthenticationData-label: AuthenticationData ------------------ .. csv-table:: :header: "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-label: LinklocalServiceEntryType ------------------------- .. csv-table:: :header: "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-label: InterfaceRouteTableServiceInstanceRefs -------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ServiceInterfaceTag`_ .. _RoutingPolicyRoutingInstanceRefs-label: RoutingPolicyRoutingInstanceRefs -------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `RoutingPolicyType`_ .. _CommunityAttributes-label: CommunityAttributes ------------------- .. csv-table:: :header: "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-label: ServiceTemplateInterfaceType ---------------------------- .. csv-table:: :header: "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-label: FirewallRuleSecurityLoggingObjectRefs ------------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `SloRateType`_ .. _RouteFilterType-label: RouteFilterType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **route_filter_properties** *optional*, "List of route filter properties.", `RouteFilterProperties`_ .. _ServiceInstanceInstanceIpRefs-label: ServiceInstanceInstanceIpRefs ----------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ServiceInterfaceTag`_ .. _AuthenticationKeyItem-label: AuthenticationKeyItem --------------------- .. csv-table:: :header: "Name", "Description", "Schema" **key_id** *optional*, "", integer **key** *optional*, "", string .. _MulticastSourceGroup-label: MulticastSourceGroup -------------------- .. csv-table:: :header: "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-label: RouteAggregateServiceInstanceRefs --------------------------------- .. csv-table:: :header: "Name", "Description", "Schema" **href** *required*, "", string **uuid** *required*, "", string **to** *required*, "Fully Qualified Name of resource", "< string > array" **attr** *optional*, "", `ServiceInterfaceTag`_ .. _RoutingPolicyParameters-label: RoutingPolicyParameters ----------------------- .. csv-table:: :header: "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-label: StaticMirrorNhType ------------------ .. csv-table:: :header: "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-label: BfdParameters ------------- .. csv-table:: :header: "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-label: PrefixMatchType --------------- .. csv-table:: :header: "Name", "Description", "Schema" **prefix** *optional*, "", string **prefix_type** *optional*, "", "Any of ['exact', 'longer', 'orlonger']" .. _BgpParameters-label: BgpParameters ------------- .. csv-table:: :header: "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-label: StaticRouteParameters --------------------- .. csv-table:: :header: "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-label: AlarmOperand2 ------------- .. csv-table:: :header: "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-label: RbacPermType ------------ .. csv-table:: :header: "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-label: PrefixListMatchType ------------------- .. csv-table:: :header: "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-label: PermType -------- .. csv-table:: :header: "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-label: ActionUpdateType ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **as_path** *optional*, "", `ActionAsPathType`_ **community** *optional*, "", `ActionCommunityType`_ **extcommunity** *optional*, "", `ActionExtCommunityType`_ **local_pref** *optional*, "", integer **med** *optional*, "", integer .. _ActionCommunityType-label: ActionCommunityType ------------------- .. csv-table:: :header: "Name", "Description", "Schema" **add** *optional*, "", `CommunityListType`_ **remove** *optional*, "", `CommunityListType`_ **set** *optional*, "", `CommunityListType`_ .. _BgpPrefixLimit-label: BgpPrefixLimit -------------- .. csv-table:: :header: "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-label: ActionExtCommunityType ---------------------- .. csv-table:: :header: "Name", "Description", "Schema" **add** *optional*, "", `ExtCommunityListType`_ **remove** *optional*, "", `ExtCommunityListType`_ **set** *optional*, "", `ExtCommunityListType`_ .. _ExtCommunityListType-label: ExtCommunityListType -------------------- .. csv-table:: :header: "Name", "Description", "Schema" **community** *optional*, "", string .. _RouteFilterProperties-label: RouteFilterProperties --------------------- .. csv-table:: :header: "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-label: CommunityListType ----------------- .. csv-table:: :header: "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-label: ActionAsPathType ---------------- .. csv-table:: :header: "Name", "Description", "Schema" **expand** *optional*, "", `AsListType`_ .. _AsListType-label: AsListType ---------- .. csv-table:: :header: "Name", "Description", "Schema" **asn_list** *optional*, "", integer