Cisco UCS Director Task Library Reference, Release 6.6

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

Results

Updated:
June 4, 2018

Chapter: General Tasks

General Tasks

This chapter contains the following sections:

Add Application Category

Summary
Add an Application Category.
Description
This task adds an Application Category in UCSD.
Inputs
Input Description Mappable To Type Mandatory
Category Label Category Label gen_​text_​input Y
Category Code Category Label gen_​text_​input
Category Description Category Description gen_​text_​input
Category Enabled Category Enabled gen_​text_​input
Default Smart Allocation Algorithm Default Smart Allocation Algorithm smart​Allocation​Algorithm​List Y
Outputs
Output Description Type
CATEGORY_​ID Category ID gen_​text_​input
CATEGORY_​NAME Category Name gen_​text_​input

Add VMware Account

Summary
Add a VMware account to the Pod.
Description
Add a VMware account to the Pod. Pod name should be given as user mapping input.
Inputs
Input Description Mappable To Type Mandatory
Cloud Name The cloud name.​ The name cannot include single quotes.​ gen_​text_​input Y
v​Center or Host Address Enter the IP address or the FQDN of the v​Center or Host.​ gen_​text_​input Y
Use Credential Policy Select if you want to use policy to give the credentials.​
Credential Policy Y
User ID The username that this account will use to access the v​Center or Host.​ This username must be a valid account with administrator or root privileges.​ gen_​text_​input Y
Password The password associated with the user id.​ password Y
Port Enter the port number of the v​Center or Host.​ gen_​text_​input Y
Access URL Enter the URL for server access.​ gen_​text_​input Y
Skip Cloud Reachability Check Select if you want to verify if v​Center server is reachable or not.​ Boolean
Outputs
No Outputs

Apply License

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Browse to select PAK license file, and click Upload button before submitting the form.​ gen_​text_​input
Enter License Text Select checkbox to enter license text instead of file upload.​
License Text Enter the License Text here gen_​text_​input Y
Outputs
No Outputs

Budget Allocation

Summary
Allocate a budget.
Description
This task allocates a budget for a Group in which a VM is provisioned.
Inputs
Input Description Mappable To Type Mandatory
No Inputs
Outputs
No Outputs

Check Group Resource Limit

Summary
Configure VM resource limits.
Description
This task sets resource limits on a VM so as not to overtax a Group.
Inputs
Input Description Mappable To Type Mandatory
No Inputs
Outputs
No Outputs

Clone Standard Catalog

Summary
Clone a standard catalog.
Description
This task clones a standard catalog.
Inputs
Input Description Mappable To Type Mandatory
Select a catalog to clone Catalog List Standard​Catalog Y
Catalog Name Catalog Name gen_​text_​input Y
Catalog Description Catalog Description gen_​text_​input
Catalog Type Catalog Type Catalog​Type Y
Catalog Icon Catalog Icon Standard​Catalog​Icon Y
Applied to all groups Applied to all groups Boolean Y
User Group ID User Group user​Group Y
Support Contact Email Address Support Contact Email Address gen_​text_​input
Publish to end users Publish to end users Boolean Y
Cloud Name Cloud Name gen_​text_​input Y
Provision new VM for ISO mounting Boolean
Provision new VM using Content Library VM Template Provision new VM using Content Library VM Template Boolean Y
Provision all disks in single datastore Provision all disks in single datastore Boolean Y
Select Folder Select Folder gen_​text_​input
Service Request Support Email Service Request Support Email
Configure Service Request Support Email Configure Service Request Support Email Boolean
Category Category ucsd​Application​Category Y
End user can override category End user can override category Boolean Y
Specify OS Specify OS gen_​text_​input
Specify Other OS Specify Other OS gen_​text_​input
Specify Applications Specify Applications gen_​text_​input
Specify Other Applications Specify Other Applications gen_​text_​input
Application Code Application Code gen_​text_​input
Credential Options Credential Options gen_​text_​input
Automatic Guest Customization Automatic Guest Customization
Enable Automatic Guest Customization Enable Automatic Guest Customization Boolean
Pre Provisioning Custom Actions Pre Provisioning Custom Actions
Enable Pre Provisioning Custom Actions Enable Pre Provisioning Custom Actions Boolean
Workflow Workflow compound​Workflow
Post Provisioning Custom Actions Post Provisioning Custom Actions
Enable Post Provisioning Custom Actions Enable Post Provisioning Custom Actions Boolean
Workflow Workflow compound​Workflow
Virtual Storage Catalog Virtual Storage Catalog
Enable Virtual Storage Catalog Enable Virtual Storage Catalog Boolean
Virtual Storage Catalog Virtual Storage Catalog gen_​text_​input
Cost Computation Cost Computation
Charge Duration Charge Duration Catalog​Charge​Unit
Active VM Application Cost Active VM Application Cost gen_​text_​input
Inactive VM Application Cost Inactive VM Application Cost gen_​text_​input
VM Life Cycle Configuration VM Life Cycle Configuration
Lease Time Lease Time Boolean
Days Days gen_​text_​input
Hours Hours gen_​text_​input
Hide end user lease configuration Hide end user lease configuration Boolean
Hide end user VM provision later Hide end user VM provision later gen_​text_​input
Web Access Configuration Web Access Configuration
Enable to allow users to access via Web browser Enable to allow users to access via Web browser Boolean
URL URL for Web access gen_​text_​input
Label Action label that user will select in access panel gen_​text_​input
Remote Desktop Access Configuration Remote Desktop Access Configuration
Enable to allow users to access via Remote Desktop Enable to allow users to access via Remote Desktop Boolean
Server Remote Desktop access server gen_​text_​input
Port Remote Desktop access port gen_​text_​input
Label Action label that user will select in access panel gen_​text_​input
VMRC Console Configuration VMRC Console Configuration
Enable to allow users to access VMRC Console Enable to allow users to access VMRC Console Boolean
Outputs
Output Description Type
CATALOG_​ID CATALOG ID Standard​Catalog
CATALOG_​NAME CATALOG NAME gen_​text_​input

CloudSense Generate Report

Summary
CloudSense Generate Report
Description
This task generates report for selected cloudsense or report builder templates.
Inputs
Input Description Mappable To Type Mandatory
Select Report Type Select Report Type Cloud​Sense​Report​Type Y
Outputs
Output Description Type
OUTPUT_​REPORT_​TYPE Cloud​Sense report type(Cloud​Sense Report or Custom Report) gen_​text_​input
OUTPUT_​CLOUDSENSE_​REPORT_​NAME Cloud​Sense Report gen_​text_​input
OUTPUT_​CLOUDSENSE_​REPORT_​TITLE Cloud​Sense Report Generated gen_​text_​input
OUTPUT_​REPORT_​BUILDER_​TEMPLATE_​NAME Report Builder Template gen_​text_​input
OUTPUT_​REPORT_​BUILDER_​REPORT_​TITLE Custom Report Generated gen_​text_​input

Collect Inventory

Summary
Collect inventory for VMware, UCS, NetApp and Network Devices.
Description
This task collects Inventory for VMware, UCS, NetApp and Network Devices.
Inputs
Input Description Mappable To Type Mandatory
VMware Account Select VMware Accounts for which inventory need to be collected.​ gen_​text_​input
UCS Account Select UCS Accounts for which inventory need to be collected.​ gen_​text_​input
Net​App Account Select Net​App Accounts for which inventory need to be collected.​ gen_​text_​input
VDI Account Select VDI Accounts for which inventory needs to be collected.​ gen_​text_​input
Network Device Select networking Device networking_​device
APIC Account Select APIC Account Apic​Device​Multi​Identity
ACI Multi-Site Account Select ACI Multi-Site Account MSCDevice​Identity
Outputs
No Outputs

Configure Mail Notification

Summary
Configure a Notification Mail.
Description
This task configures notification emails for VM events.
Inputs
Input Description Mappable To Type Mandatory
No Inputs
Outputs
No Outputs

Create IP Subnet Pool Policy

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Policy Name Policy Name gen_​text_​input Y
Policy Description Policy Description gen_​text_​input
Network Supernet Address Network Supernet Address gen_​text_​input Y
Network Supernet Mask Network Subnet Mask, ex 255.​255.​255.​0 gen_​text_​input Y
Number of Subnets Required Number of Subnets Required gen_​text_​input Y
Gateway Address Gateway Address Index IPSubnet​Pool​Policy​Gateway​Address​List Y
Allow IP Overlap Select to Allow IP Overlap IPSubnet​Pool​Policy​Alloe​IPOver​Lap​List Y
Scope Scope Policy​IPPool​Scope​Type
Outputs
Output Description Type
IP_​SUBNET_​POOL_​POLICY_​NAME Name of the IP Subnet Pool Policy Name on which the selected operation was performed gen_​text_​input
OUTPUT_​IP_​SUBNET_​POOL_​POLICY_​IDENTITY IP Subnet Pool Policy Identity IPSubnet​Pool​Policy
OUTPUT_​NETWORK_​IP Network IP ipaddress
IP_​SUBNET_​POOL_​POLICY_​NO_​OF_​SUBNETS Name of the IP Subnet Pool Policy no of subnets on which the selected operation was performed gen_​text_​input
IP_​SUBNET_​POOL_​POLICY_​OVER_​LAPING Name of the IP Subnet Pool Policy over laping on which the selected operation was performed gen_​text_​input
IP_​SUBNET_​POOL_​POLICY_​SCOPE Name of the IP Subnet Pool Policy scope on which the selected operation was performed gen_​text_​input

Create Standard Catalog

Summary
Create a standard catalog.
Description
This task creates a new standard catalog.
Inputs
Input Description Mappable To Type Mandatory
Catalog Name Catalog Name gen_​text_​input Y
Catalog Description Catalog Description gen_​text_​input
Catalog Type Catalog Type Catalog​Type Y
Catalog Icon Catalog Icon Standard​Catalog​Icon Y
Applied to all groups Applied to all groups Boolean Y
User Group ID User Group user​Group Y
Support Contact Email Address Support Contact Email Address gen_​text_​input
Publish to end users Publish to end users Boolean Y
Cloud Name Cloud Name Cloud​Name Y
Provision new VM for ISO mounting Boolean
Provision new VM using Content Library VM Template Provision new VM using Content Library VM Template Boolean Y
Image Hyper​V Image hyperv_​image_​lov Y
Vmware Image Vmware Image image Y
Provision all disks in single datastore Provision all disks in single datastore Boolean Y
Select Folder Select Folder gen_​text_​input
Service Request Support Email Service Request Support Email
Configure Service Request Support Email Configure Service Request Support Email Boolean
Category Category ucsd​Application​Category Y
End user can override category End user can override category Boolean Y
Specify OS Specify OS gen_​text_​input
Specify Other OS Specify Other OS gen_​text_​input
Specify Applications Specify Applications gen_​text_​input
Specify Other Applications Specify Other Applications gen_​text_​input
Application Code Application Code gen_​text_​input
Credential Options Credential Options gen_​text_​input
Automatic Guest Customization Automatic Guest Customization
Enable Automatic Guest Customization Enable Automatic Guest Customization Boolean
Pre Provisioning Custom Actions Pre Provisioning Custom Actions
Enable Pre Provisioning Custom Actions Enable Pre Provisioning Custom Actions Boolean
Workflow Workflow compound​Workflow
Post Provisioning Custom Actions Post Provisioning Custom Actions
Enable Post Provisioning Custom Actions Enable Post Provisioning Custom Actions Boolean
Workflow Workflow compound​Workflow
Virtual Storage Catalog Virtual Storage Catalog
Enable Virtual Storage Catalog Enable Virtual Storage Catalog Boolean
Virtual Storage Catalog Virtual Storage Catalog gen_​text_​input
Cost Computation Cost Computation
Charge Duration Charge Duration Catalog​Charge​Unit
Active VM Application Cost Active VM Application Cost gen_​text_​input
Inactive VM Application Cost Inactive VM Application Cost gen_​text_​input
VM Life Cycle Configuration VM Life Cycle Configuration
Lease Time Lease Time Boolean
Days Days gen_​text_​input
Hours Hours gen_​text_​input
Hide end user lease configuration Hide end user lease configuration Boolean
Hide end user VM provision later Hide end user VM provision later gen_​text_​input
Web Access Configuration Web Access Configuration
Enable to allow users to access via Web browser Enable to allow users to access via Web browser Boolean
URL URL for Web access gen_​text_​input
Label Action label that user will select in access panel gen_​text_​input
Remote Desktop Access Configuration Remote Desktop Access Configuration
Enable to allow users to access via Remote Desktop Enable to allow users to access via Remote Desktop Boolean
Server Remote Desktop access server gen_​text_​input
Port Remote Desktop access port gen_​text_​input
Label Action label that user will select in access panel gen_​text_​input
VMRC Console Configuration VMRC Console Configuration
Enable to allow users to access VMRC Console Enable to allow users to access VMRC Console Boolean
Outputs
Output Description Type
CATALOG_​ID CATALOG ID Standard​Catalog
CATALOG_​NAME CATALOG NAME gen_​text_​input

Delete Application Category

Summary
Delete an Application Category.
Description
This task deletes an Application Category in UCSD.
Inputs
Input Description Mappable To Type Mandatory
Application Category Application Category application​Category Y
Outputs
No Outputs

Delete Catalog

Summary
Delete a catalog.
Description
This task deletes a catalog of any type.
Inputs
Input Description Mappable To Type Mandatory
Catalog Name Catalog Name gen_​text_​input Y
Outputs
No Outputs

Delete CloudSense Report

Summary
Delete CloudSense Report
Description
This task deletes selected cloudsense report or report builder template's report.
Inputs
Input Description Mappable To Type Mandatory
Select Report Type Select Report Type Cloud​Sense​Report​Type Y
Outputs
No Outputs

Delete IP Subnet Pool Policy

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Subnet Pool Policy Select IP Subnet Pool Policy IPSubnet​Pool​Policy Y
Outputs
Output Description Type
IP_​SUBNET_​POOL_​POLICY_​NAME Name of the IP Subnet Pool Policy Name on which the selected operation was performed gen_​text_​input

Delete Workflow

Summary
Delete Orchestration Workflows.
Description
This task deletes one or more versions of one or more Orchestration Workflows. Inputs are a list of Workflow Version identities and a "Force" option. A Workflow Version identity represents a single version of a given workflow. All versions of all accessible workflows are available for selection in tabular form. Any combination of workflow-version tuples can be selected for deletion. It is important to remember that unique entries in the table are Workflow-Version pairs. To completely delete a given workflow, for example, you must choose all of its versions from the input table. Normally, the Delete Workflow task fails with an error if any of the Workflow Versions to be deleted are:
  • Currently running,,
  • Set to start on a Schedule,
  • Set to start on a Trigger, or
  • Part of a Catalog.
Choosing the Force option causes the Delete Workflow task to delete the chosen workflow-versions regardless of whether they are running or part of a Schedule, Trigger, or Catalog. Trying to use the Delete Workflow task to delete its containing workflow causes the task to fail.
Inputs
Input Description Mappable To Type Mandatory
Workflow Select Workflows To Delete workflow​Version​Identity Y
Force Delete Workflows irrespective of policies Boolean
Outputs
Output Description Type
OUTPUT_​WORKFLOW_​NAMES Workflow Names gen_​text_​input
OUTPUT_​WORKFLOW_​IDS Workflow IDs gen_​text_​input

Delete Workflow Schedule

Summary
Delete one or more Workflow Schedules.
Description
This task deletes workflow schedules. Input is a list of one or more workflow schedule identifiers. Output includes the IDs and names of the deleted schedules and their associated workflows, plus a count of the schedules deleted. Deleting a workflow has no effect on schedules associated with that workflow, and deleting a workflow schedule has no effect on associated workflows, including already running workflows.
Inputs
Input Description Mappable To Type Mandatory
Workflow Schedules Workflow Schedules workflow​Schedule​Selector Y
Outputs
Output Description Type
OUTPUT_​WORKFLOW_​SCHEDULE_​DETAIL_​IDS Workflow Schedule IDs gen_​text_​input
OUTPUT_​WORKFLOW_​SCHEDULE_​NAMES Workflow Schedule Names gen_​text_​input
OUTPUT_​WORKFLOW_​IDS Workflow IDs gen_​text_​input
OUTPUT_​WORKFLOW_​NAMES Workflow Names gen_​text_​input
OUTPUT_​SCHEDULE_​DELETE_​COUNT Deleted Schedule Count gen_​text_​input

Email CloudSense Report

Summary
Email CloudSense Report
Description
This task sends notification mail with selected cloudSense report or report builder template's report.
Inputs
Input Description Mappable To Type Mandatory
Select Report Type Select Report Type Cloud​Sense​Report​Type Y
To To gen_​text_​input Y
Subject Subject gen_​text_​input Y
Format Type Format Type gen_​text_​input Y
Email Recently Generated Report Email Recently Generated Report gen_​text_​input Y
Outputs
Output Description Type
OUTPUT_​REPORT_​TYPE Cloud​Sense report type(Cloud​Sense Report or Custom Report) gen_​text_​input
OUTPUT_​CLOUDSENSE_​REPORT_​NAME Cloud​Sense Report gen_​text_​input
OUTPUT_​CLOUDSENSE_​REPORT_​TITLE Cloud​Sense Report Generated gen_​text_​input
OUTPUT_​REPORT_​BUILDER_​TEMPLATE_​NAME Report Builder Template gen_​text_​input
OUTPUT_​REPORT_​BUILDER_​REPORT_​TITLE Custom Report Generated gen_​text_​input

Enhanced SSH Command

Summary
Executes a command in an SSH session.
Description
This task establishes an SSH session and executes the given command.
Inputs
Input Description Mappable To Type Mandatory
Account Select this option to choose the Account added in UCSD
Use Credential Policy Select this option to choose the Credential Policy added in UCSD
Credential Policy Select Credential Policy gen_​text_​input
Host IP Address Host IP Address ipaddress
Login Login gen_​text_​input
Password Password password
Command Delay Delay time between each command execution gen_​text_​input
Disable Command Echo and Command Logging If checked, commands executed through SSH are not logged in SR log nor echoed back Boolean
Check Exit Code If unchecked all commands entered get executed in a single SSH session, else if checked one command is executed per SSH session.​
Command SSH command with arguments to execute gen_​text_​input Y
Error Text Error Text to validate
Undo Command SSH undo command with arguments to execute
Error Text[Undo] Error Text to validate
Outputs
Output Description Type
OUTPUT_​SSH_​COMMAND External service request ID.​ gen_​text_​input

Execute Cloupia Script

Summary
Execute a script within a workflow.
Description
This task executes a script. You provide the script in the course of setting up the task.
Inputs
Input Description Mappable To Type Mandatory
Label Cloupia script label Y
Script Cloupia script (Java​Script compatible) Y
Undo Script Undo Cloupia script (optional, Java​Script compatible)
Outputs
No Outputs

Execute Generic API

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
No Inputs
Outputs
No Outputs

Execute Native PowerShell Command

Summary
Executes PowerShell command on native shell
Description
This task can be used to execute PowerShell scripts natively on a windows machine through PowerShell Agent. The Rollback Command/Script field is used to execute the rollback commands. The Depth field specifies how many levels of contained objects are included in the output XML. PowerShell script variables should be escaped with escape character '\' It is not required for UCSD variables like ${VMName}. Also, escape character is required to escape the escape character Example : \$test=get-hostname & c:\\test\\test.ps1
Inputs
Input Description Mappable To Type Mandatory
Label Enter a label for the task Y
Power​Shell Agent Select powershell agent gen_​text_​input Y
Hide Input in PSA, inframgr logs Hide input scripts in logs gen_​text_​input
Hide Output in PSA, inframgr logs Hide script output in logs gen_​text_​input
Commands/Script Enter commands or script.​ Max size allowed is 65536 characters.​ gen_​text_​input Y
Commands/Rollback Script Enter commands or script.​ Max size allowed is 65536 characters.​ gen_​text_​input
Output Format Choose output format of the Power​Shell script
Depth Depth Y
Maximum Wait Time Max wait time for the command to complete in minutes Y
Outputs
Output Description Type
POWERSHELL_​NATIVE_​COMMAND_​RESULT Power​Shell command result gen_​text_​input
POWERSHELL_​NATIVE_​COMMAND_​STATUS Power​Shell command status gen_​text_​input

Execute PowerShell Command

Summary
Executes PowerShell command
Description
This task can be used to execute PowerShell command on a remote windows machine through PowerShell Agent. The Rollback Command/Script field is used to execute the rollback commands. The Depth field specifies how many levels of contained objects are included in the output XML. PowerShell script variables should be escaped with escape character '\' It is not required for UCSD variables like ${VMName}. Also, escape character is required to escape the escape character Example : \$test=get-hostname & c:\\test\\test.ps1
Inputs
Input Description Mappable To Type Mandatory
Label Enter a label for the task Y
Power​Shell Agent Select powershell agent gen_​text_​input Y
Target Machine IP IP Address of target machine gen_​text_​input Y
User ID User ID gen_​text_​input Y
Password Password password Y
Domain Domain gen_​text_​input
Authentication Mechanism Select Authentication Mechanism power​Shell​Auth​Type​Identity
Hide Input in PSA, inframgr logs Hide input scripts in logs gen_​text_​input
Hide Output in PSA, inframgr logs Hide script output in logs gen_​text_​input
Commands/Script Enter commands or script.​ Max size allowed is 65536 characters.​ gen_​text_​input Y
Commands/Rollback Script Enter commands or script.​ Max size allowed is 65536 characters .​ gen_​text_​input
Output Format Choose output format of the Power​Shell script
Depth Depth
Maximum Wait Time Max wait time for the command to complete in minutes
Outputs
Output Description Type
POWERSHELL_​COMMAND_​RESULT Power​Shell command result gen_​text_​input
POWERSHELL_​NATIVE_​COMMAND_​STATUS Power​Shell command status gen_​text_​input

Fetch Generic Credential Policy

Summary
Retrieve the generic credential policy type and use as an input for other tasks.
Description
This task retrieves a generic credential policy. The generic credential policy type can be used in a workflow to fetch the credentials stored in a credential policy and map the individual credential parameters wherever applicable.
Inputs
Input Description Mappable To Type Mandatory
Generic Credential Policy Select generic credential policy Generic​Cred​Policy​Type Y
Outputs
Output Description Type
OUTPUT_​GERENIC_​CRED_​POLICY_​USERNAME User Name gen_​text_​input
OUTPUT_​GERENIC_​CRED_​POLICY_​PASSWORD Password password
OUTPUT_​GERENIC_​CRED_​POLICY_​PROTOCOL Protocol gen_​text_​input
OUTPUT_​GERENIC_​CRED_​POLICY_​PORT Port gen_​text_​input

Generate IP Subnet Pool From IP Subnet

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Subnet Select the IP Subnet Ip​Subnet​In​IPSubnet​Pool​Policy​Identity
Number of Subnets Required Number of Subnets Required Y
Gateway Address Gateway Address Index
Outputs
Output Description Type
OUTPUT_​IP_​SUBNET_​POOL_​POLICY_​IDENTITY IP Subnet Pool Policy Identity IPSubnet​Pool​Policy
OUTPUT_​NETWORK_​IP Network IP ipaddress
OUTPUT_​NETWORK_​MASK Network Mask ipaddress
OUTPUT_​SUBNET_​ID Subnet ID Ip​Subnet​In​IPSubnet​Pool​Policy​Identity
OUTPUT_​SUBNETS Subnet ID(s) gen_​text_​input

Generate VLAN from pool

Summary
Generate a VLAN from a pool.
Description
This task generates a VLAN ID from the selected VLAN pool.
Inputs
Input Description Mappable To Type Mandatory
VLAN Pool Policy Select VLAN pool policy.​ gen_​text_​input Y
Outputs
Output Description Type
OUTPUT_​VLAN_​ID VLAN ID vlan​ID
OUTPUT_​DATACENTER_​NAME Datacenter Name datacenter​Name

Generate VXLAN from pool

Summary
Generate a VXLAN from a Pool.
Description
This task generates a VXLAN (Bridge-domain) from a VXLAN Pool Policy. Tracking can be done from the Global VXLAN Pool Usage.
Inputs
Input Description Mappable To Type Mandatory
VXLAN Pool Policy Select VXLAN pool policy.​ gen_​text_​input Y
Outputs
Output Description Type
OUTPUT_​VXLAN_​ID VXLAN ID vxlan​ID
OUTPUT_​DATACENTER_​NAME Datacenter Name datacenter​Name

Get IP Address From IP Subnet

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
User Group ID User Group user​Group
Container ID Container ID Service​Container
IP Subnet Select the IP Subnet Ip​Subnet​In​IPSubnet​Pool​Policy​Identity
IP Subnet Label IP Subnet Label gen_​text_​input
Outputs
Output Description Type
IPAddress IPAddress ipaddress
Subnet​Mask Subnet​Mask ipaddress
Gate​Way​IP Gate​Way​IP ipaddress
IP Address with Slash Subnet IP Address with Slash Subnet gen_​text_​input
Subnet​Mask Bitwise Value Subnet​Mask Bitwise Value gen_​text_​input
OUTPUT_​USED_​BY Used By gen_​text_​input
OUTPUT_​SUBNET_​MASK Subnet Mask subnet​Mask

Get IP Address From Pool

Summary
Return the resolved IP address from a selected IP Pool Policy.
Description
This task retrieves a Resolved IP address, along with subnet mask and gateway IP Address, from the selected IP Pool Policy Range.
Inputs
Input Description Mappable To Type Mandatory
User Group ID User Group user​Group
Container ID Container ID Service​Container
Select IP Pool Select the IPPool to resolve IP Address IPPool​Policy Y
Outputs
Output Description Type
IPAddress IPAddress gen_​text_​input
Subnet​Mask Subnet​Mask gen_​text_​input
Gate​Way​IP Gate​Way​IP gen_​text_​input

Get IP Subnet From IP Subnet Pool Policy

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Subnet Pool Policy Select IP Subnet Pool Policy IPSubnet​Pool​Policy Y
User Group ID User Group user​Group
Container ID Container ID Service​Container
IP Subnet Label IP Subnet Label gen_​text_​input
Outputs
Output Description Type
OUTPUT_​BROADCAST_​IP Broadcast IP ipaddress
OUTPUT_​GATEWAY_​IP Gateway IP ipaddress
OUTPUT_​NETWORK_​IP Network IP ipaddress
OUTPUT_​NETWORK_​MASK Network Mask ipaddress
OUTPUT_​SUBNET_​POOL_​ID Subnet Pool ID gen_​text_​input
OUTPUT_​SUBNET_​ID Subnet ID Ip​Subnet​In​IPSubnet​Pool​Policy​Identity
OUTPUT_​SUBNET_​LABEL Subnet Label gen_​text_​input
OUTPUT_​GROUP_​ID Group ID user​Group
OUTPUT_​IP_​SUBNET_​POOL_​POLICY_​IDENTITY IP Subnet Pool Policy Identity IPSubnet​Pool​Policy
OUTPUT_​CONTAINER_​ID Container ID Service​Container
OUTPUT_​USED_​BY Used By gen_​text_​input

Get IP Subnet From Parent IP Subnet

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Subnet Select the IP Subnet Ip​Subnet​In​IPSubnet​Pool​Policy​Identity Y
Outputs
Output Description Type
OUTPUT_​BROADCAST_​IP Broadcast IP ipaddress
OUTPUT_​GATEWAY_​IP Gateway IP ipaddress
OUTPUT_​NETWORK_​IP Network IP ipaddress
OUTPUT_​NETWORK_​MASK Network Mask ipaddress
OUTPUT_​SUBNET_​POOL_​ID Subnet Pool ID gen_​text_​input
OUTPUT_​SUBNET_​ID Subnet ID Ip​Subnet​In​IPSubnet​Pool​Policy​Identity

Get Tabular Report Column Value

Summary
Retrieves a value from the selected search column of a report in UCSD.
Description
This task retrieves a column value as output given a column index and a value in the report. Inputs to this task can be found in report metadata if the developer menu is enabled in UCSD.
Inputs
Input Description Mappable To Type Mandatory
Report Context Type Enter report context type.​Only numeric values are allowed gen_​text_​input Y
Report Context ID Enter report context id gen_​text_​input Y
Report ID Enter api report id gen_​text_​input Y
Search Column Enter the column index to be searched.​Index starts from 1 considering hidden columns gen_​text_​input Y
Search Value Enter the column value to be searched gen_​text_​input Y
Output Column Enter the column index to be fetched.​Index starts from 1 considering hidden columns gen_​text_​input Y
Outputs
Output Description Type
OUTPUT_​RETURN_​STATUS_​VALUE Return Status Value.​ gen_​text_​input
OUTPUT_​COLUMN_​VALUE Selected Column Value.​ gen_​text_​input

Guest Password Reset

Summary
Reset a guest password.
Description
This task resets a guest password.
Inputs
Input Description Mappable To Type Mandatory
No Inputs
Outputs
No Outputs

Modify Standard Catalog

Summary
Modify a standard catalog.
Description
This task modifies a standard catalog.
Inputs
Input Description Mappable To Type Mandatory
Select a catalog to modify Catalog List Standard​Catalog Y
Catalog Description Catalog Description gen_​text_​input
Catalog Type Catalog Type Catalog​Type Y
Catalog Icon Catalog Icon Standard​Catalog​Icon Y
Applied to all groups Applied to all groups Boolean Y
User Group ID User Group user​Group Y
Support Contact Email Address Support Contact Email Address gen_​text_​input
Publish to end users Publish to end users Boolean Y
Cloud Name Cloud Name Cloud​Name Y
Provision new VM for ISO mounting Boolean
Provision new VM using Content Library VM Template Provision new VM using Content Library VM Template Boolean Y
Provision all disks in single datastore Provision all disks in single datastore Boolean Y
Select Folder Select Folder gen_​text_​input
Service Request Support Email Service Request Support Email
Configure Service Request Support Email Configure Service Request Support Email Boolean
Category Category ucsd​Application​Category Y
End user can override category End user can override category Boolean Y
Specify OS Specify OS gen_​text_​input
Specify Other OS Specify Other OS gen_​text_​input
Specify Applications Specify Applications gen_​text_​input
Specify Other Applications Specify Other Applications gen_​text_​input
Application Code Application Code gen_​text_​input
Credential Options Credential Options gen_​text_​input
Automatic Guest Customization Automatic Guest Customization
Enable Automatic Guest Customization Enable Automatic Guest Customization Boolean
Pre Provisioning Custom Actions Pre Provisioning Custom Actions
Enable Pre Provisioning Custom Actions Enable Pre Provisioning Custom Actions Boolean
Workflow Workflow compound​Workflow
Post Provisioning Custom Actions Post Provisioning Custom Actions
Enable Post Provisioning Custom Actions Enable Post Provisioning Custom Actions Boolean
Workflow Workflow compound​Workflow
Virtual Storage Catalog Virtual Storage Catalog
Enable Virtual Storage Catalog Enable Virtual Storage Catalog Boolean
Virtual Storage Catalog Virtual Storage Catalog gen_​text_​input
Cost Computation Cost Computation
Charge Duration Charge Duration Catalog​Charge​Unit
Active VM Application Cost Active VM Application Cost gen_​text_​input
Inactive VM Application Cost Inactive VM Application Cost gen_​text_​input
VM Life Cycle Configuration VM Life Cycle Configuration
Lease Time Lease Time Boolean
Days Days gen_​text_​input
Hours Hours gen_​text_​input
Hide end user lease configuration Hide end user lease configuration Boolean
Hide end user VM provision later Hide end user VM provision later gen_​text_​input
Web Access Configuration Web Access Configuration
Enable to allow users to access via Web browser Enable to allow users to access via Web browser Boolean
URL URL for Web access gen_​text_​input
Label Action label that user will select in access panel gen_​text_​input
Remote Desktop Access Configuration Remote Desktop Access Configuration
Enable to allow users to access via Remote Desktop Enable to allow users to access via Remote Desktop Boolean
Server Remote Desktop access server gen_​text_​input
Port Remote Desktop access port gen_​text_​input
Label Action label that user will select in access panel gen_​text_​input
VMRC Console Configuration VMRC Console Configuration
Enable to allow users to access VMRC Console Enable to allow users to access VMRC Console Boolean
Outputs
Output Description Type
CATALOG_​ID CATALOG ID Standard​Catalog
CATALOG_​NAME CATALOG NAME gen_​text_​input

Modify Workflow Priority

Summary
Modify the workflow priority.
Description
This task modifies the workflow execution priority. High, medium, or low priorities can be assigned to a workflow.
Inputs
Input Description Mappable To Type Mandatory
Priority Modify Workflow Priority Y
Outputs
No Outputs

Multi User Approval

Summary
Request approval from one or more users or groups.
Description
This task requests approval from one or more users or groups. An approving user can be anyone who has an account on the UCS Director system. The task waits indefinitely until a user, or a user belongs to an approval group, approves or rejects the request. Inputs to the task include a flag that requires all users to approve the request. By default, only one of the users must approve the request in order to continue. If Approval required from all the users flag is set and groups are selected as approvers, then all users in all the groups must approve in order to continue. UCS Director sends an email requesting the approval of users or of users belongs to the approval group. The email includes request information, including the complete workflow.
Inputs
Input Description Mappable To Type Mandatory
When Disable Rollback is enabled, the approval task will not be run during service request rollback
Approval required from Groups The checkbox should be enabled, if approval required from Group
User Group ID Group ID of the user who should approve the request user​Group Y
User ID User ID of the user who should approve the request cuic_​multi_​user_​ID Y
Approval required from all the users The checkbox should be enabled, if approval required from all the users.​ Else, any one user approval is enough Approval​Required​From​All​Users
Number of Approval Request Reminders Number of reminder emails to be sent resend​Mail​Count Y
Reminder Intervals (Hours) Time interval to send the next approval request reminder email reminder​Interval Y
Outputs
No Outputs

NetApp Cluster Resource Selector

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Volume Size Enter the size of Volume.​ gen_​text_​input Y
Volume Size Units Select the Volume Size Units.​ storage​Size​Unit
Server Name Select Server gen_​text_​input Y
Outputs
Output Description Type
OUTPUT_​NETAPP_​CLUSTER_​VSERVER_​IDENTITY Net​App Cluster SVM Identity netapp​Cluster​VServer​Identity
OUTPUT_​NETAPP_​CLUSTER_​AGGREGATE_​IDENTITY Net​App Cluster Aggregate Identity aggregate​Cluster​Identity
OUTPUT_​NETAPP_​CLUSTER_​VOLUME_​SIZE Net​App Cluster Volume Size net​App​Vol​Size
OUTPUT_​NETAPP_​CLUSTER_​LUN_​SIZE Net​App Cluster LUN Size gen_​text_​input
OUTPUT_​VOLUME_​SIZE_​UNITS Net​App Volume Size Units size​Unit
OUTPUT_​HOST_​VHBA1_​ADAPTER_​NAME Host VHBA2 Adaptor Name(WWPN) gen_​text_​input
OUTPUT_​HOST_​VHBA2_​ADAPTER_​NAME Host VHBA2 Adaptor Name(WWPN) gen_​text_​input

Notify URL

Summary
Notifies the specified URL.
Description
This task executes a GET or POST request on the specified URL. For example, this task can be used to post results of previous tasks to an URL or a Web service.
Inputs
Input Description Mappable To Type Mandatory
URL URL gen_​text_​input Y
Method Method gen_​text_​input Y
Authentication Method Authentication Method gen_​text_​input
Outputs
No Outputs

Parse PowerShell Output

Summary
Parses the output of Execute Powershell Command or Execute Native Powershell Command task
Description
The task is used to parse the output from Execute Powershell Command task or Execute Native Powershell Command task. The input to this task should be in JSON or XML format. For JSON data, it should be either a simple JSON data or a JSON array but it does not consider complex JSON data like array within an array. The output from this task will be key value pairs.
Inputs
Input Description Mappable To Type Mandatory
Powershell Output Powershell Output gen_​text_​input Y
Outputs
No Outputs

Release Reserved IP Subnet

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Subnet Select the IP Subnet Ip​Subnet​In​IPSubnet​Pool​Policy​Identity Y
Outputs
No Outputs

Remove Capacity Reservation

Summary
Remove Capacity Reservation from User Group.
Description
This task allows user to remove reservation of an entity(ex: UCS-Server)from a particular User Group.
Inputs
Input Description Mappable To Type Mandatory
Reservation ID Reservation ID Capacity​Reservation Y
Outputs
No Outputs

Remove IP Address Reservation

Summary
Remove an IPAddress Reservation.
Description
This task removes an IP address reservation.
Inputs
Input Description Mappable To Type Mandatory
Reserved IPAddress Select the reserved IP Address gen_​text_​input Y
Outputs
Output Description Type
IPAddress IPAddress ipaddress

Remove IP Subnet Pool From IP Subnet

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Subnet Select the IP Subnet Ip​Subnet​In​IPSubnet​Pool​Policy​Identity
Outputs
No Outputs

Reserve Capacity

Summary
Reserve a entity (ex: UCS-Server) for a particular time to User Group.
Description
This task allows user to reserve a entity for (ex: UCS-Server) a particular time to User Group.
Inputs
Input Description Mappable To Type Mandatory
Resource Type Resource Type gen_​text_​input Y
Resource Identity Resource Identity gen_​text_​input Y
Amount Allocated Amount Allocated gen_​text_​input
Allocated Data Allocated Data gen_​text_​input
Allocted to Group Allocted to Group gen_​text_​input
Valid Until Valid Until date_​time
Comments Comments gen_​text_​input Y
Outputs
No Outputs

Rollback Child Service Request

Summary
Roll back a workflow.
Description
This task rolls back a workflow. Input is the ID of the service to roll back.
Inputs
Input Description Mappable To Type Mandatory
Service Request ID Select SR to rollback gen_​text_​input Y
Outputs
No Outputs

Rollback Execute Generic API

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
IP Address Select API IP gen_​text_​input
Port Select API Port gen_​text_​input
API Path Select API Path gen_​text_​input
Protocol Protocol gen_​text_​input Y
HTTP Request Type HTTP Request Type gen_​text_​input Y
HTTP Content Type HTTP Content Type gen_​text_​input Y
Use Proxy Select this option to use system proxy configuration
Header Parameters Add one or more Filter Criteria to filter out matching resources
Use HTTP Basic Authentication Select this option to pass HTTP basic authentication parameters during API call
Username Username gen_​text_​input Y
Password Password gen_​text_​input Y
Request Template Content Body Template Content gen_​text_​input
Outputs
No Outputs

SSH Command

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Host IP Address Host IP Address ipaddress Y
Login Login gen_​text_​input Y
Password Password password Y
Command SSH command with arguments to execute gen_​text_​input Y
Error Text Error Text to validate
Undo Command SSH undo command with arguments to execute
Error Text[Undo] Error Text to validate
Outputs
Output Description Type
OUTPUT_​SSH_​COMMAND External service request ID.​ gen_​text_​input

Send Email

Summary
Send a notification email.
Description
This task sends email to a specified user after the task or workflow is completed. Email address, subject, and body of the mail are given as inputs. The output of this task is an email address.
Inputs
Input Description Mappable To Type Mandatory
E-mail Addresses Comma separated E-mail addresses email_​address_​list Y
Cc E-mail Addresses Comma separated E-mail addresses email_​address_​list
Bcc E-mail Addresses Comma separated E-mail addresses email_​address_​list
Subject Subject with template variables such as $VM_​ID, $VM_​NAME Y
Body Email Body/Content with template variables such as $VM_​ID, $VM_​NAME
Outputs
Output Description Type
EMAIL_​ADDRESSES Email Address of the user on which the selected operation was performed email_​address_​list
Bcc_​EMAIL_​ADDRESSES Bcc Email Address of the user on which the selected operation was performed email_​address_​list
Cc_​EMAIL_​ADDRESSES Cc Email Address of the user on which the selected operation was performed email_​address_​list

Send Email Through Template

Summary
Send Email Through Template
Description
This task allows user to send an email from a template. (Note: We recommend using the user-defined custom email template to generate an email using this task.)
Inputs
Input Description Mappable To Type Mandatory
E-mail Addresses Comma separated E-mail addresses email_​address_​list Y
Cc E-mail Addresses Comma separated E-mail addresses email_​address_​list
Bcc E-mail Addresses Comma separated E-mail addresses email_​address_​list
Subject Subject with template variables such as $VM_​ID, $VM_​NAME Y
Select Email Template Select Email Template
Body Email Body/Content with template variables such as $VM_​ID, $VM_​NAME
Reset To Default Set Default Script
Outputs
Output Description Type
EMAIL_​ADDRESSES Email Address of the user on which the selected operation was performed email_​address_​list
Bcc_​EMAIL_​ADDRESSES Bcc Email Address of the user on which the selected operation was performed email_​address_​list
Cc_​EMAIL_​ADDRESSES Cc Email Address of the user on which the selected operation was performed email_​address_​list

Set the starting time for the next task

Summary
Set the start time for the next task.
Description
This task sets the time at which to start execution of the next task in the workflow.
Inputs
Input Description Mappable To Type Mandatory
Next task execution time Set the starting time for the next task date_​time Y
Outputs
No Outputs

Update Application Category

Summary
Modify an Application Category.
Description
This task modifies an Application Category in UCSD.
Inputs
Input Description Mappable To Type Mandatory
Application Category Application Category application​Category Y
Category Label Category Label gen_​text_​input Y
Category Code Category Label gen_​text_​input
Category Description Category Description gen_​text_​input
Category Enabled Category Enabled gen_​text_​input
Default Smart Allocation Algorithm Default Smart Allocation Algorithm smart​Allocation​Algorithm​List Y
Outputs
Output Description Type
CATEGORY_​ID Category ID gen_​text_​input
CATEGORY_​NAME Category Name gen_​text_​input

VMware VM Provision Inputs

Summary
Identify VMWare VM Provision Inputs.
Description
This task identifies inputs for provisioning a VM. The task provides the option to override the datastores selected for each disk.
Inputs
Input Description Mappable To Type Mandatory
Assign To User Choosing this option will allow VM assignment to user assign​To​User
User VM will be assigned to this user cuic_​user_​ID
Catalog/ VM Selection Catalog/ VM Selection
VM Deployment Options Select Deployment options to perform the action vm​Clone​Type Y
Select Catalog Select Catalog on which to perform the action catalog
Select VM Select the VM to retrieve the properties vm
Image Select the image.​ image
Use Linked Clone Clone VM using linked clone feature gen_​text_​input
Customization Options Customization Options
Select Category Select a v​DC Category vdc​Category
Select Windows License Pool Select Windows License Pool windows​License​Pool
Select Credential Options Select Credential Options crendential​Options
Provision all disks in single datastore Provision all disks in single datastore, the scope will be same as system disk scope provision​All​Disk​In​Same​Datastore
Enable Guest Customization Enable Guest Customization Enable​Guest​Customization
Select Pre-Provision Workflow Select Pre-Provision Workflow custom​Action​Workflow
Select Workflow Select Custom Workflow custom​Action​Workflow
Select VM App Charge Frequency Select VM App Charge Frequency vm​Application​Charge​Frequency
Active VM Application Cost Enter Active VM Application Cost gen_​text_​input
Inactive VM Application Cost Enter In Active VM Application Cost gen_​text_​input
Deployment Options Deployment Options
Select v​DC Select v​DC on which to perform the action v​DC Y
VM Name or VM Prefix Enter VM Name or VM Prefix gen_​text_​input
Comment Enter Comment gen_​text_​input
Provision Enter Comment provision​Period
Provision Time Provision Time date_​time
Lease Time Enter Comment VMware​Power​Off​VM
Days Enter Days gen_​text_​input
Hours Enter Hours gen_​text_​input
Custom Specification Custom Specification
CPU Cores CPU Cores v​CPUCount
Cores Per Socket Cores Per Socket cores​Per​Socket
Memory Memory mem​Size​MB
Storage Tier Storage Tier storage​Tier​Policy
VM Charge Frequency Select the frequency of charging the VM vm​Charge​Frequency
Disk Datastores Disk Datastores
Override Datastore and Size storage​Policy​Disk​Datastore​Override
VM Disks Enter Disk Datastores in JSON Format gen_​text_​input
Optional NIC Portgroups Disk Datastores
VM NIC Configuration Configure VM Nics vmware​Vmnics​Configuration​Formmanagedlist
Override NIC IP network​Policy​NICIPOverride
Outputs
Output Description Type
OUTPUT_​VDC_​PRIMARY_​APPROVERS v​DC Primary Approvers cuic_​user_​ID
OUTPUT_​VDC_​SECONDARY_​APPROVERS v​DC Secondary Approvers cuic_​user_​ID
APPROVAL_​REQUIRED_​FROM_​ALL_​USERS Approval required from all users Approval​Required​From​All​Users
OUTPUT_​VDC_​REMINDER_​INTERVAL Reminder Intervals (Hours) reminder​Interval
OUTPUT_​VDC_​RESEND_​MAIL_​COUNT Number of Approval Request Reminders resend​Mail​Count

Wait For Service Requests

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Service Request IDs Comma separated Service Request IDs service​Request​Id​List Y
Max Wait Time How long to wait for completion of SRs Y
All SRs Must Succeed Consider this task successful only if all SRs are successful
Outputs
Output Description Type
COMPLETED_​SR_​ID_​LIST Service Request IDs that were completed service​Request​Id​List
FAILED_​SR_​ID_​LIST Service Request IDs that were failed service​Request​Id​List
TIMEDOUT_​SR_​ID_​LIST Service Request IDs that were timed out service​Request​Id​List

Wait for Specified Duration

Summary
Wait for a fixed duration.
Description
This task waits for a number of seconds specified in its input.
Inputs
Input Description Mappable To Type Mandatory
Duration How long to wait before executing next task in the workflow gen_​text_​input Y
Outputs
No Outputs

Wait for User Approval

Summary
Request approval from a user or group.
Description
This task requests approval from either a user who has an account on the UCS Director system, or from any UCS Director group. The service request waits indefinitely until the user, or a user belonging to the approval group, approves or rejects the request. UCS Director sends an email requesting the approval of the user or user belonging to the approval group. The email contains information about the request, including the complete workflow. If Approval required from all the users flag is set and groups are selected as approvers, then all users in all the groups must approve in order to continue. The request email is based on an approval email template specified in the input. If no template is specified, a default approval email template is used. The email template body and subject can be further customized when the task is added to the workflow. Separate approvals can be required for approval of service request rollbacks using a separate, parallel set of system templates and task-level customizations.
Inputs
Input Description Mappable To Type Mandatory
When Disable Rollback is enabled, the approval task will not be run during service request rollback
Approval required from Groups The checkbox should be enabled, if approval required from Group
User Group ID Group ID of the user who should approve the request user​Group Y
User ID User ID of the user who should approve the request cuic_​user_​ID Y
Approval required from all the users The checkbox should be enabled, if approval required from all the users.​ Else, any one user approval is enough Approval​Required​From​All​Users
Number of Approval Request Reminders Number of reminder emails to be sent resend​Mail​Count Y
Reminder Intervals (Hours) Time interval to send the next approval request reminder email reminder​Interval Y
Use Approval email template Choose a template to send Approval email with
Select Email Template Select Email Template
Subject Subject with template variables such as $VM_​ID, $VM_​NAME Y
Body Email Body/Content with template variables such as $VM_​ID, $VM_​NAME
Reset To Default Set Default Script
Use Approval email template during Rollback Choose a template to send Approval email with, during Rollback
Select Email Template Select Email Template
Subject Subject with template variables such as $VM_​ID, $VM_​NAME Y
Body Email Body/Content with template variables such as $VM_​ID, $VM_​NAME
Reset To Default Set Default Script
Outputs
No Outputs

Was this Document Helpful?

FeedbackFeedback

Contact Cisco