APIC - Contract Operations

This chapter contains the following sections:

Add Filter To APIC Contract Subject

Summary
Add a filter to a contract subject.
Description
This task adds a filter to a contract subject for a tenant on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Contract Subject Select a contract subject.​ Apic​Tenant​Contract​Subject​Identity Y
Filter Select a filter.​ Apic​Device​Tenant​Filter​Identity Y
Apply Both Directions Check Apply Both Directions either true or false.​ Defaults to unchecked.​ gen_​text_​input
Log check to choose log option for directives.​ Boolean
No Stats check to choose No Stats option for directives.​ Boolean
Action Select Action.​ the default value is empty string.​ Apic​Subject​Action​Identity
Priority Select Priority.​ the default value is empty string.​ Apic​Subject​Priority​Identity
Filter For Consumer To Provider Select a filter for consumer to provider.​ Apic​Device​Tenant​Filter​Identity
Log check to choose log option for directives.​ Boolean
No Stats check to choose No Stats option for directives.​ Boolean
Consumer To Provider Action Select Consumer To Provider Action.​ the default value is empty string.​ Apic​Subject​Action​Identity
Consumer To Provider Priority Select Consumer To Provider Priority.​ the default value is empty string.​ Apic​Subject​Priority​Identity
Filter For Provider To Consumer Select a filter for provider to consumer.​ Apic​Device​Tenant​Filter​Identity
Log check to choose log option for directives.​ Boolean
No Stats check to choose No Stats option for directives.​ Boolean
Provider To Consumer Action Select Action.​ the default value is empty string.​ Apic​Subject​Action​Identity
Provider To Consumer Priority Select Priority.​ the default value is empty string.​ Apic​Subject​Priority​Identity
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity
TENANT_​FILTER Tenant's Filter gen_​text_​input
TENANT_​FILTER_​IDENTITY Tenant Filter Identity Apic​Device​Tenant​Filter​Identity
TENANT_​IN_​TERM_​FILTER Tenant In Term Filter Name gen_​text_​input
TENANT_​IN_​TERM_​FILTER_​IDENTITY Tenant In Term Filter Identity Apic​Device​Tenant​Filter​Identity
TENANT_​OUT_​TERM_​FILTER Tenant Out Term Filter Name gen_​text_​input
TENANT_​OUT_​TERM_​FILTER_​IDENTITY Tenant Out Term Filter Identity Apic​Device​Tenant​Filter​Identity
OUTPUT_​FILTER_​CONTRACT_​SUBJECT_​IDENTITY Filter Contract Subject Identity Apic​Device​Tenant​Filter​To​Contract​Subject​Identity
OUTPUT_​CONSUMER_​TO_​PROVIDER_​FILTER_​CONTRACT_​SUBJECT_​IDENTITY Consumer To Provider Filter Contract Subject Identity Apic​Device​Tenant​Filter​To​Contract​Subject​Identity
OUTPUT_​PROVIDER_​TO_​CONSUMER_​FILTER_​CONTRACT_​SUBJECT_​IDENTITY Provider To Consumer Filter Contract Subject Identity Apic​Device​Tenant​Filter​To​Contract​Subject​Identity

Add Label To APIC Contract Subject

Summary
Add a label to a contract subject.
Description
This task adds a label to a contract subject on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Contract Subject Select a contract subject.​ Apic​Tenant​Contract​Subject​Identity Y
Match​Type Select Match type as one of At​Least​One, At​Most​One, None or All.​ Default Match Type value is Atleast​One.​ gen_​text_​input Y
Label Name Enter a contract subject Label name.​ gen_​text_​input Y
Label Tag Select Tag to Subject Provided Label.​ Default tag value is Black.​ gen_​text_​input
Complement Check to enable Provided Label Complement.​ Default Complement value is unchecked.​
Match​Type Select Match Type as At​Least​One, At​Most​One, None or All.​ Default Match Type value is Atleast​One.​ gen_​text_​input Y
Label Name Enter Consumed Subject Label name.​ gen_​text_​input Y
Label Tag Select Tag to Subject Consumed Label.​ Default tag value is Black.​ gen_​text_​input
Complement Check to enable Provided Label Complement.​ Default Complement value is unchecked.​
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity
TENANT_​CONTRACT_​SUBJECT_​PROVIDED_​LABEL Contract Subject Provided Label gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​PROVIDED_​LABEL_​IDENTITY Contract Subject Provided Label Identity Apic​Device​Tenant​Label​Contract​Subject​Identity
TENANT_​CONTRACT_​SUBJECT_​PROVIDED_​LABEL_​TAG Contract Subject Provided Label Tag gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​PROVIDED_​LABEL_​TAG_​IDENTITY Contract Subject Provided Label Tag Identity gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​CONSUMED_​LABEL Contract Subject Consumed Label gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​CONSUMED_​LABEL_​IDENTITY Contract Subject Consumed Label Identity Apic​Device​Tenant​Label​Contract​Subject​Identity
TENANT_​CONTRACT_​SUBJECT_​CONSUMED_​LABEL_​TAG Contract Subject Consumed Label Tag gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​CONSUMED_​LABEL_​TAG_​IDENTITY Contract Subject Consumed Label Tag Identity gen_​text_​input

Create APIC Contract

Summary
Create a contract.
Description
This task creates a contract for a tenant on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Tenant Name Select a tenant name.​ Apic​Device​Tenant​Identity Y
Contract Name Enter a contract name.​ gen_​text_​input Y
Contract Alias Provide Contract Alias gen_​text_​input
Scope Choose a scope.​ Specify any one of these values: application-profile, context, global, tenant.​ The default value is application-profile.​ gen_​text_​input Y
Qos Class Choose Priority.​ The priority level of the Qo​S can be unspecified, level1, level2 or level3.​ The default value is 'unspecified'.​ gen_​text_​input Y
DSCP Target Select DSCP Target value between 0 to 64 and default value is 'unspecified'.​ Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter DSCP Target Enter DSCP Target value between 0 to 64 and default value is 'unspecified' gen_​text_​input
Contract Description Provide Description for Contract gen_​text_​input
Tags Provide Tenant Tags Apic​Device​Tag​Identity
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity

Create APIC Contract Subject

Summary
Create a contract subject.
Description
This task creates a contract subject for a tenant on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Contract Name Select a contract name to add the subject to.​ Apic​Device​Tenant​Contract​Identity Y
Type Choose a type.​ The default value is normal.​ gen_​text_​input
Contract Subject Name Enter a contract subject name.​ gen_​text_​input Y
Contract Subject Alias Enter alias name to contract subject.​ gen_​text_​input
Contract Subject Description Enter a description for the contract subject.​ gen_​text_​input
Target DSCP Select a target DSCP.​ Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter Target DSCP Enter a target DSCP value between 0 to 64.​ gen_​text_​input
Reverse Filter Ports Check reverse filter ports.​ Defaults to unchecked.​ gen_​text_​input
Apply Both Directions Check apply both directions.​ Defaults to unchecked.​ gen_​text_​input
Service Graph Select a service graph.​ Apic​Device​Tenant​Service​Graph​Identity
QOS Choose a Qo​S Class.​ Specify any one of: level1, level2, level3, unspecified.​ The default value is 'level1'.​ gen_​text_​input
In Term Service Graph Select an In Term service graph.​ Apic​Device​Tenant​Service​Graph​Identity
In Term QOS Priority Select in term QOS priority.​ gen_​text_​input
Target DSCP [In Term] Select a target DSCP.​ Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter Target DSCP [In Term] Enter a target DSCP value between 0 to 64.​ gen_​text_​input
Out Term Service Graph Select an Out Term service graph.​ Apic​Device​Tenant​Service​Graph​Identity
Out Term QOS Priority Select out term QOS priority.​ gen_​text_​input
Target DSCP [Out Term] Select a target DSCP.​ Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter Target DSCP [Out Term] Enter a target DSCP value between 0 to 64.​ gen_​text_​input
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity
TENANT_​SERVICE_​GRAPH_​IDENTITY APIC Tenant Bidirectional Service Graph Identity Apic​Device​Tenant​Service​Graph​Identity

Create APIC Export Contract

Summary
Create a contract for export.
Description
This task creates a contract for export that includes the existing contract information and its identity information.
Inputs
Input Description Mappable To Type Mandatory
Contract Name Enter a contract name, Use alphanumeric characters only.​ gen_​text_​input Y
Description Enter additional descriptive information for the contract.​ gen_​text_​input
Contract Select a contract name.​ Apic​Device​Tenant​Contract​Identity Y
Tenant Name Select a tenant name.​ Apic​Device​Tenant​Identity Y
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
IMPORT_​CONTRACT_​NAME Contract Name gen_​text_​input
EXPORT_​CONTRACT_​IDENTITY Apic Device Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
IMPORT_​CONTRACT_​IDENTITY Apic Device Tenant Contract Identity Apic​Device​Tenant​Imported​Contract​Identity
DEVICE_​TENANT_​IMPORT_​CONTRACT_​IDENTITY Apic Tenant Import Contract Identity Apic​Device​Tenant​Import​Contract​Identity

Delete APIC Contract

Summary
Delete a contract.
Description
This task deletes a contract on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Contract Name Select a contract name.​ Apic​Device​Tenant​Contract​Identity Y
Do you want to delete the selected Contract? Y
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity

Delete APIC Contract Subject

Summary
Delete a contract subject.
Description
This task deletes a contract subject for a tenant on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Contract Subject Name Select a contract subject name for deletion.​ Apic​Tenant​Contract​Subject​Identity Y
Do you want to delete the selected Contract Subject? Y
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity

Delete Filter From APIC Contract Subject

Summary
Delete a filter rule from a contract subject in UCSD.
Description
This task deletes a filter rule From a contract subject. It takes a filter identity as input.
Inputs
Input Description Mappable To Type Mandatory
Filter Select a filter.​ Apic​Device​Tenant​Filter​To​Contract​Subject​Identity Y
Do you want to delete the selected Filter To Contract Subject? Y
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity
TENANT_​FILTER Tenant's Filter gen_​text_​input
TENANT_​FILTER_​IDENTITY Tenant Filter Identity Apic​Device​Tenant​Filter​Identity

Delete Imported Contract

Summary
Delete a contract that was imported in to a tenant.
Description
This contract deletes a contract that was imported in to a tenant.
Inputs
Input Description Mappable To Type Mandatory
Select Imported Contract Name Select the imported contract name to be removed.​ Apic​Device​Tenant​Import​Contract​Identity Y
Outputs
Output Description Type
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
IMPORT_​CONTRACT_​NAME Contract Name gen_​text_​input
DEVICE_​TENANT_​IMPORT_​CONTRACT_​IDENTITY Apic Tenant Import Contract Identity Apic​Device​Tenant​Import​Contract​Identity

Delete Label From APIC Contract Subject

Summary
Delete a label from a contract subject.
Description
This task deletes a label from a contract subject on the APIC controller.
Inputs
Input Description Mappable To Type Mandatory
Label Name Select Label From APIC Contract Subject.​ Apic​Device​Tenant​Label​Contract​Subject​Identity Y
Do you want to delete the selected Label from Contract Subject? Do you want to delete the selected Label from Contract Subject? Y
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity
TENANT_​LABEL_​CONTRACT_​SUBJECT_​IDENTITY APIC Tenant EPG Contract Identity Apic​Device​Tenant​Epg​Contract​Identity
TENANT_​CONTRACT_​SUBJECT_​PROVIDED_​LABEL Contract Subject Provided Label gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​PROVIDED_​LABEL_​IDENTITY Contract Subject Provided Label Identity Apic​Device​Tenant​Label​Contract​Subject​Identity
TENANT_​CONTRACT_​SUBJECT_​CONSUMED_​LABEL Contract Subject Consumed Label gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​CONSUMED_​LABEL_​IDENTITY Contract Subject Consumed Label Identity Apic​Device​Tenant​Label​Contract​Subject​Identity

Modify APIC Contract Subject

Summary
Modifies a contract subject in UCSD.
Description
This task updates a contract subject. It accepts a contract subject name and a service graph name as input.
Inputs
Input Description Mappable To Type Mandatory
Contract Subject Name Select a contract subject name.​ Apic​Tenant​Contract​Subject​Identity Y
Contract Subject Alias Enter alias name to contract subject gen_​text_​input
Contract Subject Global Alias Enter global alias name to contract subject gen_​text_​input
Description Enter a description.​ The description can be up to 128 alphanumeric characters.​ gen_​text_​input
Reverse Filter Ports Reverse Filter Ports gen_​text_​input
Apply Both Directions Apply Both Directions gen_​text_​input
Service Graph Service Graph Apic​Device​Tenant​Service​Graph​Identity
QOS Provide QOS Class gen_​text_​input
Target DSCP Select a target DSCP Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter Target DSCP Enter a target DSCP value between 0 to 64 gen_​text_​input
In Term Service Graph In Term Service Graph Apic​Device​Tenant​Service​Graph​Identity
In Term QOS Provide QOS Class gen_​text_​input
Target DSCP [In Term] Select a target DSCP Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter Target DSCP [In Term] Enter a target DSCP value between 0 to 64 gen_​text_​input
Out Term Service Graph Out Term Service Graph Apic​Device​Tenant​Service​Graph​Identity
Out Term QOS Provide QOS Class gen_​text_​input
Target DSCP [Out Term] Select a target DSCP Apic​Custom​Qos​Policy​Dscp​Target​Identity
Enter Target DSCP [Out Term] Enter a target DSCP value between 0 to 64 gen_​text_​input
Outputs
Output Description Type
APIC_​ACCOUNT APIC Account on which the selected operation was performed Apic​Device​Identity
TENANT_​NAME Tenant Name on which the selected operation was performed gen_​text_​input
TENANT_​IDENTITY APIC Tenant Identity Apic​Device​Tenant​Identity
TENANT_​CONTRACT APIC Tenant Contract gen_​text_​input
TENANT_​CONTRACT_​IDENTITY APIC Tenant Contract Identity Apic​Device​Tenant​Contract​Identity
CONTRACT_​SUBJECT Contract Subject gen_​text_​input
TENANT_​CONTRACT_​SUBJECT_​IDENTITY Contract Subject Identity Apic​Tenant​Contract​Subject​Identity
TENANT_​SERVICE_​GRAPH_​IDENTITY APIC Tenant Bidirectional Service Graph Identity Apic​Device​Tenant​Service​Graph​Identity
TENANT_​INTERM_​SERVICE_​GRAPH_​IDENTITY APIC Tenant Interm Service Graph Identity Apic​Device​Tenant​Service​Graph​Identity
TENANT_​OUTTERM_​SERVICE_​GRAPH_​IDENTITY APIC Tenant Outterm Service Graph Identity Apic​Device​Tenant​Service​Graph​Identity