OOB Contract

Location in GUI: Tenants » mgmt » Contracts » Out-Of-Band Contracts

Diagram

Classes

tenants (apic)

Name	Type	Constraint	Mandatory	Default Value
oob_contracts	List	[oob_contracts]	No

oob_contracts (apic.tenants)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
alias	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	No
description	String	Regex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$	No
scope	Choice	application-profile, tenant, context, global	No	context
subjects	List	[subjects]	No
expected_state	Class	[expected_state]	No

subjects (apic.tenants.oob_contracts)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
alias	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	No
description	String	Regex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$	No
service_graph	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	No
filters	List	[filters]	No

expected_state (apic.tenants.oob_contracts)

Name	Type	Constraint	Mandatory	Default Value
minimum_health	Integer	min: 0, max: 100	No
maximum_critical_faults	Integer	min: 0	No
maximum_major_faults	Integer	min: 0	No
maximum_minor_faults	Integer	min: 0	No

filters (apic.tenants.oob_contracts.subjects)

Name	Type	Constraint	Mandatory	Default Value
filter	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes

Examples

Simple example:

apic:
  tenants:
    - name: mgmt
      oob_contracts:
        - name: OOB-CON1
          subjects:
            - name: OOB-SUB
              filters:
                - filter: ALL

Full example:

apic:
  tenants:
    - name: mgmt
      oob_contracts:
        - name: OOB-CON1
          alias: OOB-CON1-ALIAS
          description: My Desc
          scope: context
          subjects:
            - name: OOB-SUB
              alias: OOB-SUB-ALIAS
              description: My Desc
              filters:
                - filter: ALL