Contract

Location in GUI: Application Management » Schemas

Diagram

Classes

templates (ndo.schemas)

Name	Type	Constraint	Mandatory	Default Value
contracts	List	`[contracts]`	No

contracts (ndo.schemas.templates)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
scope	Choice	`application-profile`, `tenant`, `context`, `global`	No	`context`
type	Choice	`bothWay`, `oneWay`	No	`bothWay`
filters	List	`[filters]`	No
provider_to_consumer_filters	List	`[provider_to_consumer_filters]`	No
consumer_to_provider_filters	List	`[consumer_to_provider_filters]`	No
service_graph	Class	`[service_graph]`	No

filters (ndo.schemas.templates.contracts)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
schema	String		No
template	String		No
log	Boolean	`true`, `false`	No	`false`
policy_compression	Boolean	`true`, `false`	No	`false`

service_graph (ndo.schemas.templates.contracts)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
schema	String		No
template	String		No
nodes	List	`[nodes]`	Yes

nodes (ndo.schemas.templates.contracts.service_graph)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
index	Integer	min: `1`, max: `3`	No
provider	Class	`[provider]`	Yes
consumer	Class	`[consumer]`	Yes

provider (ndo.schemas.templates.contracts.service_graph.nodes)

Name	Type	Constraint	Mandatory
bridge_domain	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
schema	String		No
template	String		No
sites	List	`[sites]`	Yes

consumer (ndo.schemas.templates.contracts.service_graph.nodes)

Name	Type	Constraint	Mandatory
bridge_domain	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
schema	String		No
template	String		No
sites	List	`[sites]`	Yes

sites (ndo.schemas.templates.contracts.service_graph.nodes.provider)

Name	Type	Constraint	Mandatory
name	String		Yes
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
device	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
logical_interface	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
redirect_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

sites (ndo.schemas.templates.contracts.service_graph.nodes.consumer)

Name	Type	Constraint	Mandatory
name	String		Yes
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
device	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
logical_interface	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
redirect_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

Examples

ndo:
  schemas:
    - name: ABC
      templates:
        - name: TEMPLATE1
          contracts:
            - name: CONTRACT1
              scope: context
              type: bothWay
              filters:
                - name: FILTER1
                  schema: ABC
                  template: TEMPLATE1
                  log: true
                  policy_compression: true
              service_graph:
                name: SG1
                nodes:
                  - name: FW1
                    provider:
                      bridge_domain: BD1
                      sites:
                        - name: APIC1
                          device: DEV1
                          logical_interface: INT1
                          redirect_policy: PBR1
                    consumer:
                      bridge_domain: BD1
                      sites:
                        - name: APIC1
                          device: DEV1
                          logical_interface: INT1
                          redirect_policy: PBR1