Cisco UCS Director Task Library Reference, Release 6.7

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco UCS Director Task Library Reference, Release 6.7

Chapter Title

Containers

Results

Updated:
January 15, 2019

Chapter: Containers

Containers

This chapter contains the following sections:

APIC Container L4 L7 Service Info Wrapper

Summary
L4 L7 Service Info wrapper.
Description
Inputs
Input Description Mappable To Type Mandatory
L4 L7 Id String gen_​text_​input
Outputs
Output Description Type
Primary​L4L7Identity Primary L4 L7 Identity Container L4 L7 Service
Primary​Container​Id Primary Container ID Service​Container
DREnabled DR Enabled Boolean
Secondary​L4L7Identity Secondary​L4L7Identity Container L4 L7 Service
Secondary​Container​Id Secondary​Container​Id Service​Container

APICContainerDRMappingWrapper

Summary
Wrapper for getting required information for creating SRM mappings for DR
Description
Inputs
Input Description Mappable To Type Mandatory
PRIMARY_​SERVICE_​CONTAINER_​ID Service​Container
SECONDARY_​SERVICE_​CONTAINER_​ID Service​Container
Outputs
Output Description Type
PRIMARY_​CONTAINER_​VMS gen_​text_​input
PRIMARY_​CONTAINER_​TIERS gen_​text_​input
PRIMARY_​POOL_​IDENTITY vmware​Resource​Pool​Identity
SECONDARY_​POOL_​IDENTITY vmware​Resource​Pool​Identity
PRIMARY_​CONTAINER_​VMS_​COUNT gen_​text_​input
SRM_​PROTECTION_​GROUP_​IDENTITY vmware​SRMProtection​Group​Identity
VMS multi​VM
PRIMARY_​FOLDER_​IDENTITY Primary Container Folder Identity VMware​Folder​Identity
SECONDARY_​FOLDER_​IDENTITY Secondary Container Folder Identity VMware​Folder​Identity
PG_​IDENTITIES Port Group Identities gen_​text_​input

APICContainerInfoWrapper

Summary
Wrapper task for providing necessary information for container L4 L7 Services, SRM related settings for container etc
Description
Inputs
Input Description Mappable To Type Mandatory
CONTAINER_​ID Service​Container
VMS gen_​text_​input
Primary L4L7 Service Container L4 L7 Service
Outputs
Output Description Type
IS_​DR_​ENABLED IS_​DR_​ENABLED Boolean
VMS_​ID_​LIST VMS multi​VM
SRM_​PROTECTION_​GROUP_​IDENTITY vmware​SRMProtection​Group​Identity
SECONDARY_​CONTAINER_​ID Secondary Container ID Service​Container
SECONDARY_​L4L7_​SERVICE_​ID SECONDARY_​L4L7_​SERVICE_​ID Container L4 L7 Service
L4L7_​SERVICE_​INFO_​IDS_​FOR_​ITERATIONS L4L7_​SERVICE_​INFO_​IDS_​FOR_​ITERATIONS gen_​text_​input

APIC_L4L7_ASAv_Network_VLAN_Info

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service Container Service​Container
VM_​NAME gen_​text_​input
Tier1_​BD gen_​text_​input
Tier2_​BD gen_​text_​input
Outputs
Output Description Type
VM_​IDENTITY vm
OUTPUT_​ASAV_​VLAN1 vlan​ID
OUTPUT_​ASAV_​VLAN2 vlan​ID
SP_​VNICs ucs​Service​Profile​Multiv​NICIdentity
UCS_​Account ucs​Account​Identity

ConvertSecurityRuleTextToIdentity

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Security​Rule gen_​text_​input
Outputs
Output Description Type
Security​Rule​Identity Security​Rule​Identity

CreateAPICContainerFolder

Summary
Create Container Folder on vCenter if not exists already otherwise returns the existing folder id.
Description
Inputs
Input Description Mappable To Type Mandatory
Service Container Id Service​Container
Outputs
Output Description Type
Folder​Identity Folder Identity gen_​text_​input

Get APIC Container Free Infra IP And Mask

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service_​Container Service​Container
Outputs
Output Description Type
IP gen_​text_​input
IP_​MASK gen_​text_​input
Gateway gen_​text_​input

Get APIC Container LB SNIP IP

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service_​Container Service​Container
Tier gen_​text_​input
Is​Service​Chain gen_​text_​input
Arm​Mode gen_​text_​input
Multiple_​Service_​Chain_​Type gen_​text_​input Y
Outputs
Output Description Type
INTERNAL_​IP gen_​text_​input
INTERNAL_​IP_​MASK gen_​text_​input
Is​SNIPConfig​Required Is​SNIPConfig​Required gen_​text_​input

Get APIC Container LB VIP

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service_​Container Service​Container
Tier gen_​text_​input
Arm​Mode gen_​text_​input
Service​Name gen_​text_​input
is​Service​Chain gen_​text_​input
Outputs
Output Description Type
VIP_​OUTPUT gen_​text_​input
VIP_​MASK gen_​text_​input
VIP_​NETWORK_​IP gen_​text_​input
is​VIPRequired is​VIPRequired gen_​text_​input

Get APIC Container PG Identities Wrapper

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
PRIMARY_​SECONDARY_​IDENTITY_​STRING gen_​text_​input
Outputs
Output Description Type
Primary​Container​PGIdentity Primary​Container​PGIdentity VMware​DVPortgroup​Identity
Secondary​Container​PGIdentity Secondary​Container​PGIdentity VMware​DVPortgroup​Identity
Primary​Container​PGType Primary​Container​PGType port​Group​Type
Secondary​Container​PGType Secondary​Container​PGType port​Group​Type

Get APIC Container Tier Type

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service_​Container Service​Container
Tier_​Name gen_​text_​input
Outputs
Output Description Type
Tier_​Type gen_​text_​input

Get Cloud Type From Container

Summary
Get Cloud Type From Container
Description
Inputs
Input Description Mappable To Type Mandatory
Service_​Container Service​Container
Outputs
Output Description Type
Cloud_​Type Cloud_​Type gen_​text_​input

Get Container Info

Summary
Provides Tenant, Private Network, Contract, Subject, Service Graph Identities
Description
Inputs
Input Description Mappable To Type Mandatory
Service Container Service​Container Y
Consumer Tier gen_​text_​input Y
Provider Tier gen_​text_​input Y
Outputs
Output Description Type
Tenant​Identity Apic​Device​Tenant​Identity
Private​Network​Identity Apic​Device​Tenant​Private​Network​Identity
Contract​Identity Apic​Device​Tenant​Contract​Identity
Contract​Subject​Identity Apic​Tenant​Contract​Subject​Identity
Service​Graph​Identity Apic​Device​Tenant​Service​Graph​Identity
Provider​Tier Provider Tier Name gen_​text_​input
Consumer​Tier Consumer​Tier Name gen_​text_​input
Container​Name gen_​text_​input
Provider​EPGIdentity Apic​Device​Tenant​EPGIdentity
Consumer​EPGIdentity Apic​Device​Tenant​EPGIdentity
Service​Graph​Node​Identity Apic​Tenant​L4L7Service​Graph​Node​Identity
LBSubnet​Policy​ID IPSubnet​Pool​Policy
LBSubnet​Identity gen_​text_​input
Service​Name gen_​text_​input

Get L4L7 Device Deployment Info

Summary
Determine if the mgmt ip, mask etc should be used from L4L7 Info wrapper or from deploy workflow.
Description
Determine if the mgmt ip, mask etc should be used from L4L7 Info wrapper or from deploy workflow.
Inputs
Input Description Mappable To Type Mandatory
Mgmt IP gen_​text_​input
Deploy​Mgmt​IP gen_​text_​input
Mgmt​Port gen_​text_​input
Deploy​Mgmt​Port gen_​text_​input
User​Name gen_​text_​input
Deploy​User​Name gen_​text_​input
Password password
Deploy​Password password
VMName gen_​text_​input
Secondary​VMName gen_​text_​input
Deploy​ASAv gen_​text_​input
Service​Type gen_​text_​input
Device​Type gen_​text_​input
Sec​Mgmt​IP gen_​text_​input
Deploy​Sec​Mgmt​IP gen_​text_​input
Cluster IP From Wrapper gen_​text_​input
Cluster​User​Name​From​Wrapper gen_​text_​input
Cluster​Password​From​Wrapper password
Context​Aware gen_​text_​input
Dep​VMName gen_​text_​input
Sec​Dep​VMName gen_​text_​input
Cluster​IP_​Deployed gen_​text_​input
Cluster​User​Name_​Deployed gen_​text_​input
Cluster​Password_​Deployed password
Outputs
Output Description Type
Management​IP Management​IP gen_​text_​input
Management​Port Management​Port gen_​text_​input
Username User​Name gen_​text_​input
User​Password Password password
Virtual​Machine​Name VMName gen_​text_​input
Sec​Virtual​Machine​Name Sec​Virtual​Machine​Name gen_​text_​input
Sec​Management​IP Sec​Management​IP gen_​text_​input
APICService​Type APICService​Type gen_​text_​input
Cluster​IP gen_​text_​input
Cluster​User​Name gen_​text_​input
Cluster​Password password

Get LB Server Details

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IPv46 gen_​text_​input Y
Provider EPG Identity gen_​text_​input Y
Service Graph Node Identity gen_​text_​input Y
Contract Name gen_​text_​input Y
Outputs
Output Description Type
lb​Vserver lb​Vserver gen_​text_​input
L4L7Element L4L7 Element Apic​Tenant​L4L7Parameter​Identity
L4L7Element​Parameter L4L7 Element Parameter - lbserver Apic​Tenant​L4L7Parameter​Values​Identity
Param​Name Param Name gen_​text_​input
L4L7Lb​Menthod​Param L4L7 Lb Menthod Parameter Apic​Tenant​L4L7Parameter​Values​Identity
L4L7Pers​Type​Param L4L7 Persistence Type Parameter Apic​Tenant​L4L7Parameter​Values​Identity
lb​Server​Param​Value LB Server Name Parameter Value gen_​text_​input
LBMethod​Key lbmethod gen_​text_​input
Persistence​Type​Key persistencetype gen_​text_​input
Cookie​Key cookiekey gen_​text_​input
L4L7Cookie​Param Cookie​Name Apic​Tenant​L4L7Parameter​Values​Identity
L4L7Element​Param​SG gen_​text_​input
L4L7Port​Param Apic​Tenant​L4L7Parameter​Values​Identity
Port​Key gen_​text_​input
L4L7Port​Param1 Apic​Tenant​L4L7Parameter​Values​Identity
SGBinding​Fold​Names Service Group Binding Folder Names gen_​text_​input
Service​Graph​Name Service Graph Name gen_​text_​input
Contract​Name​Out Contract Name gen_​text_​input

GetACLIdentityToDelete

Summary
Checks and returns ACL identity of the acl to be deleted.
Description
Checks and returns ACL identity of the acl to be deleted.
Inputs
Input Description Mappable To Type Mandatory
L4L7Identity gen_​text_​input
ACLName gen_​text_​input
ACEName gen_​text_​input
Outputs
Output Description Type
is​ACLTo​Be​Deleted is​ACLTo​Be​Deleted Boolean
ACLIdentity ACL Identity Apic​Tenant​L4L7Acl​EPGIdentity
Interface​Identity Interface​Identity Apic​Tenant​L4L7EPGInterface​Identity
In​Bound​ACL In​Bound​ACL gen_​text_​input
Out​Bound​ACL Out​Bound​ACL gen_​text_​input

GetApicContainerACEIdentity

Summary
Generates ACE identity using L4L7Id and ACE Name.
Description
Generates ACE identity using L4L7Id and ACE Name.
Inputs
Input Description Mappable To Type Mandatory
L4L7Id Container L4 L7 Service
ACE Name gen_​text_​input
Outputs
Output Description Type
ACEIdentity ACEIdentity Apic​Tenant​L4L7EPGAce​Identity
ACLName ACL Name gen_​text_​input

GetL4L7DeviceArmMode

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service​Type gen_​text_​input
Multiple​Service​Type gen_​text_​input
Orig​Arm​Mode gen_​text_​input
Outputs
Output Description Type
Custom_​Arm​Mode Custom_​Arm​Mode gen_​text_​input

GetMSPAdminEmailAddresses

Summary
Retrieves MSP Admins for given tenant.
Description
Retrieves MSP Admins for given tenant.
Inputs
Input Description Mappable To Type Mandatory
Tenant Apic​Device​Tenant​Identity Y
Outputs
Output Description Type
MSPOrg​Admin​Emails MSPOrg​Admin​Emails email_​address_​list

GetResourceRequirementFromThroughput

Summary
Reterives vCPU and Memory requirement for L4L7 Devices
Description
Reterives vCPU and Memory requirement for L4L7 Devices
Inputs
Input Description Mappable To Type Mandatory
container​Id Service​Container
Outputs
Output Description Type
ASAv_​v​CPU ASAv_​v​CPU gen_​text_​input
VPX_​v​CPU VPX_​v​CPU gen_​text_​input
VPX_​Memory VPX_​Memory gen_​text_​input
Deployment​Option Deployment​Option gen_​text_​input

GetTargetsForLBParamConfiguration

Summary
This task finds out any existing service chain configuration details.
Description
Inputs
Input Description Mappable To Type Mandatory
Container Service​Container
Arm​Mode gen_​text_​input
Provider​EPG Apic​Device​Tenant​EPGIdentity
APICContract​Identity Apic​Device​Tenant​Contract​Identity
Service​Graph​Node​Identity Apic​Tenant​L4L7Service​Graph​Node​Identity
Service​Chain gen_​text_​input
Outputs
Output Description Type
Tier​To​Configure​EPG gen_​text_​input
EPGIdentity Apic​Device​Tenant​EPGIdentity
Contract​Identity Apic​Device​Tenant​Contract​Identity
SGNode​Identity Apic​Tenant​L4L7Service​Graph​Node​Identity
Existing​SNIP gen_​text_​input
Existing​Chained​FWNode Apic​Tenant​L4L7Service​Graph​Node​Identity
SSLSGNode​Identity SSLSGNode​Identity Apic​Tenant​L4L7Service​Graph​Node​Identity
SSLContract​Identity SSLContract​Identity Apic​Device​Tenant​Contract​Identity
SSLExisting​FWNode​Identity SSLExisting​FWNode​Identity Apic​Tenant​L4L7Service​Graph​Node​Identity

Get_APICContainerL4L7DefinitionForPrivateNetwork

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service Container Service​Container
Index gen_​text_​input
Outputs
Output Description Type
Tier_​1 gen_​text_​input
Tier_​2 gen_​text_​input
Services gen_​text_​input
LBServers gen_​text_​input
Arm_​Mode gen_​text_​input
Is​Multiple​Services gen_​text_​input
Multiple_​Service_​Type gen_​text_​input
Service​Name Service​Name gen_​text_​input

Get_APICContainerL4L7ServiceForProtocol

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service Container gen_​text_​input
Service Name gen_​text_​input
Outputs
Output Description Type
Protocol_​Type gen_​text_​input
Port gen_​text_​input

IsFWLBSingleArmChainExist

Summary
This task finds out any existing service chain configuration details.
Description
Inputs
Input Description Mappable To Type Mandatory
Container Service​Container
Outputs
Output Description Type
FWLBChain​Exist gen_​text_​input

Trigger APIC Container - DR Site

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Container_​Name gen_​text_​input Y
Container_​Label gen_​text_​input
Tenant UCSDTenant​Identity
Container_​template application​Template
Configure_​resource_​limit Boolean
Memory gen_​text_​input
Maximum​Storage​Limit gen_​text_​input
No_​of_​v​CPUs gen_​text_​input
No​Of​Host​Per​Tier gen_​text_​input
Tiers gen_​text_​input
Half_​width_​phy_​servers gen_​text_​input
Full_​width_​phy_​servers gen_​text_​input
Network_​throughput gen_​text_​input
Enable_​nw_​mgmt Boolean
Enable_​DR Boolean
User_​group user​Group
Primary​Container​Id Service​Container
Outputs
Output Description Type
SR_​List service​Request​Id​List

Trigger Multiple Container Tier Creation

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Container Service​Container Y
Tenant ID gen_​text_​input Y
APIC Application Profile gen_​text_​input Y
Container Private Network Apic​Device​Tenant​Private​Network​Identity Y
Tier List gen_​text_​input Y
Outputs
Output Description Type
SR_​List service​Request​Id​List

Trigger Multiple L4L7 Device Interface Creation

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Container Service​Container Y
Service_​Type gen_​text_​input Y
Tier List gen_​text_​input Y
Physical Device Static Path Identity Apic​Device​Static​Path​Identity
Is​ASAv​HA gen_​text_​input Y
Is​LBHA gen_​text_​input Y
Device Cluster Package Identity Apic​Device​Cluster​Device​Package​Identity Y
Concrete Device 1 Identity Apic​Device​Tenant​Concrete​Device​Identity Y
Concrete Device 2 Identity Apic​Device​Tenant​Concrete​Device​Identity Y
Device Type gen_​text_​input
Existing​Concrete​Interface​Name gen_​text_​input
Sec​Physical​Static​Path Apic​Device​Static​Path​Identity
Sec​Existing​Concrete​Interface​Name gen_​text_​input
Outputs
Output Description Type
SR_​List service​Request​Id​List

Trigger Multiple L4L7 Services

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service_​Container Service​Container Y
Service_​Order_​Type gen_​text_​input Y
Outputs
Output Description Type
SR_​List service​Request​Id​List

Trigger Required Network Devices Configuration

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Container Service​Container Y
L4L7_​Req_​Services gen_​text_​input Y
Outputs
Output Description Type
SR_​List service​Request​Id​List

VPXVMResizeCheck

Summary
Checks if VPX vm resize is needed.
Description
Checks if VPX vm resize is needed.
Inputs
Input Description Mappable To Type Mandatory
Primary​VPXVMId gen_​text_​input
Cpu​Count gen_​text_​input
Memory gen_​text_​input
Secondary​VPXVMId gen_​text_​input
Outputs
Output Description Type
IS_​PRIMARY_​VPX_​VM_​RESIZE_​REQUIRED IS_​PRIMARY_​VPX_​VM_​RESIZE_​REQUIRED Boolean
VPX_​CPU VPX_​CPU v​CPUCount
VPX_​MEMORY VPX_​MEMORY mem​Size​MB
VPX_​VM_​PRIMARY Primary VPX VM vm
VPX_​VM_​SECONDARY VPX_​VM_​SECONDARY vm
IS_​SECONDARY_​VPX_​VM_​RESIZE_​REQUIRED IS_​SECONDARY_​VPX_​VM_​RESIZE_​REQUIRED Boolean

Was this Document Helpful?

FeedbackFeedback

Contact Cisco