Download - Examples - Cisco...Examples Thischaptercontainsthefollowingsections: • ManagingGroups,page2 • ManagingCatalogs,page8 • ManagingPhysicalAccounts,page13 ...

Examples

This chapter contains the following sections:

• Managing Groups, page 2

• Managing Catalogs, page 8

• Managing Physical Accounts, page 13

• Managing Virtual Data Centers, page 20

• Managing Virtual Infrastructure Policies, page 30

• Managing APIC Virtual Infrastructure Policies, page 36

• Managing Service Containers, page 42

• Managing Contracts, page 55

• Managing Virtual Machines, page 59

• Setting up a VMware VM Guest and Executing VIX Script, page 64

• Managing VMware System Policy, page 66

• Deleting a VMware Snapshot, page 75

• Managing Workflow Orchestration, page 76

• Retrieving Workflow Fields, page 81

• Managing MSP, page 89

• Managing Reports, page 90

Cisco UCS Director REST API Cookbook, Release 5.5 1

Managing Groups

Creating a GroupObjective

Create a new group with the specified data (group name, description, and contact details) in Cisco UCSDirector.

Context

It is mandatory to create a group before adding a service end-user or group admin to Cisco UCSDirector.A service end-user or group admin is assigned to a group. Based on the permissions, users within thegroup will inherit read/write permissions to resources.

Prerequisites

The REST API must be called with an admin user ID.

REST URL

Request/app/api/rest?formatType=json&opName=userAPICreateGroup&opData={param0:{"groupId":8,"groupName":"SDK_Demo_Group","description":"testgroup","parentGroupId":-1,"parentGroupName":"any","emailAddress":"[email protected]","lastName":"sdk","firstName":"ay","phoneNumber":"2344566","address":"SanJose","groupType":0,"enableBudget":true}}

Response{ "serviceResult":2, "serviceError":null, "serviceName":"InfraMgr","opName":"userAPICreateGroup" }

Cisco UCS Director REST API Cookbook, Release 5.52

ExamplesManaging Groups

Components

The parameters of the userAPICreateGroup API are:

• int groupId—The unique ID of the group.

• String groupName—The name of the group or the customer organization.

• String description—Optional. The description of the group or the customer organization, if required.

• int parentGroupId—If the parent group ID is greater than 0, the created group name is mappedto parent group ID. If a group belongs to a parent group or an organization, the parentId andparentGroupName parameters are mandatory. If the group type is set as 0, the group name andemail address are mandatory.

• String emailAddress—The email used to notify the group owner about the status of service requestsand request approvals if necessary.

• String lastName—Optional. The last name of the group owner.

• String firstName—Optional. The first name of the group owner.

• String phoneNumber—Optional. The phone number of the group owner.

• String address—Optional. The address of the group owner.

• int groupType—The group type is set as 0 for administrator or end user, and as 1 for ManagedService Provider (MSP) organization user.

• boolean enableBudget—Set to true to create a group with a budget watch.


ExamplesCreating a Group

Code

JSON-based APIimport com.cisco.cuic.api.client.APIGroup;import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.UserAPIGlobal;

public class UserAPIGlobalExample{public static void main(String[] args)throws Exception {CuicServer server =

CuicServer.getAPI("192.0.110.241","49B39356003846FFB5162C3E12F3DD07", "https", 443);

UserAPIGlobal instance = new UserAPIGlobal(server);

APIGroup apiGroup=new APIGroup();apiGroup.setFirstName("SDK");apiGroup.setLastName("cisco");apiGroup.setGroupName("SDKGroup");apiGroup.setEmailAddress("[email protected]");apiGroup.setEnableBudget(false);

int obj = instance.userAPICreateGroup(apiGroup);System.out.println(obj);

}}

Alternately, you can use the XML-based API called userAPIGroupcreate to create a group.

The userAPIGroupcreate API includes the following additional parameters:

• GroupCode—A shorter name or code name for the group. This name is used in VM and hostnametemplates.

• GroupSharePolicyId—The ID of group share policy for the users in this group.

public class userAPIGroupExample{public static void main(String[] args) throws Exception {CuicServer server = CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64","https", 443);AddGroupConfig instance = new AddGroupConfig(server);instance.setGroupName("SDK Grp XML");instance.setGroupDescription("SDK group XML ");//Parent group is empty.Optional not required.instance.setParentGroup("");

//Group code is also empty.Optional not required.instance.setGroupCode("");instance.setGroupContact("[email protected]");instance.setFirstName("SDK ");instance.setLastName("XML");instance.setPhone("1234567");instance.setAddress("SanJose");instance.setGroupSharePolicyId("");instance.setAllowPrivateUsers(false);AddGroupConfigResponse groupReponse = instance.execute();System.out.println(“Group id = ”+groupReponse.getOUTPUT_GROUP_ID());}

}

Results

A unique group ID is returned after successful creation of a group in the Cisco UCS Director server.

Implementation

You can create a group either using the userAPICreateGroup API or the userAPIGroupcreate API. Ifyou want to create a group using the data in XML format, use the userAPIGroupcreate API.


ExamplesCreating a Group

See Also

Listing All Groups

Modifying a Group

Deleting a Group

Listing All GroupsObjective

Retrieve all groups in Cisco UCS Director as a list.

Context

Retrieve the list of groups in Cisco UCS Director.

Prerequisites

The requesting user must be authorized to get the list of groups.

REST URL/app/api/rest?formatType=json&opName=userAPIGetGroups&opData={}

Components

None

Codepublic class userAPIGetGroupsExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);List<APIGroup> groupsList = instance.userAPIGetGroups();for (Iterator iterator = groupsList.iterator(); iterator.hasNext();){APIGroup apiGroup = (APIGroup) iterator.next();System.out.println("Group id = "+apiGroup.getGroupId());System.out.println(" Group Name = "+apiGroup.getGroupName());}}

}

Results

The code returns a list of groups in Cisco UCS Director.

Implementation

No implementation required.


ExamplesListing All Groups

See Also

Creating a Group

Modifying a Group

Deleting a Group

Modifying a GroupObjective

Update a group with the given details. The group ID and group name cannot be edited.

Context

Update the contact details and description of the group.

Prerequisites

The logged-in user must have permissions to modify the group.

REST URL/app/api/rest?formatType=json&opName=userAPIUpdateGroup&opData={param0:{"groupId":2,"groupName":"SDKTest","description":"testing","parentGroupId":9,"parentGroupName":"Test","emailAddress":"[email protected]","lastName":"","firstName":"","phoneNumber":"","address":"","groupType":0}}

Components

apiGroup APIGroup

APIGroup is a group object that holds group information such as group name, description, and emailaddress. It is mandatory to pass the group name to update the group.

Codepublic class userAPIUpdateGroupExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);APIGroup apiGroup = new APIGroup();apiGroup.setGroupName("SDK");apiGroup.setEmailAddress("[email protected]");apiGroup.setDescription("Update test");boolean isUpdated = instance.userAPIUpdateGroup(apiGroup);System.out.println("is updated " + isUpdated);}

}

Results

If the group is updated successfully, the result is true.


ExamplesModifying a Group

Implementation

Pass the group name and set the necessary group properties that needs to be updated.

See Also

Creating a Group

Listing All Groups

Deleting a Group

Deleting a GroupObjective

Delete a group from Cisco UCS Director based on the given group ID.

Context

Ensure that the user belonging to the group will not access resources in Cisco UCS Director server.

Prerequisites

The group ID must be available in Cisco UCS Director. You can retrieve the group ID using theuserAPIGetGroups API.

REST URL/app/api/rest?formatType=json&opName=userAPIDeleteGroup&opData={param0:2}

Components

int groupId—The unique ID of the group that needs to be deleted.

Codepublic class userAPIDeleteGroupExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);//Get the Group id by executing List<APIGroup> groupsList =

instance.userAPIGetGroups();boolean obj = instance.userAPIDeleteGroup(2);System.out.println("is Deleted successfully ? " + obj);}

}

Results

If the group is deleted successfully, the result is true.


ExamplesDeleting a Group

Implementation

Delete a group by passing the group ID.

See Also

Creating a Group

Listing All Groups

Modifying a Group

Managing Catalogs

Creating a Catalog ItemObjective

Create a catalog item for provisioning a VM, under one of the following catalog types:

• Standard—For creating catalogs for VM provisioning using images from a list of clouds.

• Advanced—For publishing orchestration workflows such as catalog items.

• Service Container—For publishing application containers as catalog items.

• Virtual desktop infrastructure (VDI)—For publishing Xen Desktop as catalog items.

The catalog item defines parameters such as the cloud name and the group name to which the VM isbound.

Context

The system administrator creates a catalog item.

Prerequisites

• The cloud, image, and groups must exist in Cisco UCS Director.


ExamplesManaging Catalogs

REST URL

Request/app/api/rest?formatType=json&opName=userAPICreateCatalogItem&opData={param0:{"catalogType":"Standard","catalogItemName":"standardCatalog1","catalogItemDescription":"Api crated it","catalogIcon":"VM: SUSE Linux","isAppliedToAllGroups":false,"groups":"Default Group","publishToEndUsers":true,"folderName":"Standard","standardCatalog":{"cloudName":"vmware117","image":"CentOSTiny","category":"Generic VM","supportEmail":"[email protected]","os":"Windows Server 2012","otherOS":"Linux Server","appLists":"Apache Web Server","otherApps":"Glass Fish web server","applicationCode":"sdk","credentialOption":"Do not share","userId":"admin","password":"root","isAutomaticGuestCustomization":false,"enablePostProvisioningCustomActions":false,"workflowName":"Print Number","parameters":[{"name":"Name1","value":"Value1"},{"name":" Name2","value":" Value2"}]},"advancedCatalog":{"workflowName":"Create Vdc","parameters":[{"name":"Name1","value":"Value1"},{"name":"Name2","value":"Value2"}]},"ServiceContainerCatalog":{"serviceContainerTemplateName":"servicecontainertemp1","parameters":[{"name":"Name1","value":"Vlue1"},{"name":"Name2","value":"Value2"}]},"vdiCatalog":{"cloudName":"Cloud1","imageId":"image1","xenDesktopCatalog":"catalog1","category":"category1","supportEmail":"[email protected]","allowEndUserToOverrideCategory":true,"parameters":[]}}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"userAPICreateCatalogItem" }

Components

APICatalogItem item


ExamplesCreating a Catalog Item

Codeimport java.util.ArrayList;import java.util.List;

import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.UserAPIGlobal;import com.cisco.cuic.api.models.catalog.APICatalogItem;import com.cisco.cuic.api.models.catalog.StandardCatalogParameters;import com.cisco.cuic.api.models.catalog.NameValuePair;

public class UserAPICreateCatalogItemSdkSample{public static void main(String[] args){CuicServer server = CuicServer.getAPI("172.29.110.194","5AD45F2DC5ED441A9A743F1B219CC302", "http", 80);UserAPIGlobal instance = new UserAPIGlobal(server);List<NameValuePair> nameValuePairs = new ArrayList<NameValuePair>();

StandardCatalogParameters standardCatalogParameters = newStandardCatalogParameters();

standardCatalogParameters.setCloudName("vmware117");standardCatalogParameters.setImage("CentOSTiny");standardCatalogParameters.setCategory("Generic VM");standardCatalogParameters.setSupportEmail("[email protected]");standardCatalogParameters.setOs("Windows Server 2012");standardCatalogParameters.setOtherOS("Linux Server");standardCatalogParameters.setAppLists("Apache Web Server");standardCatalogParameters.setOtherApps("Glass Fish web server");standardCatalogParameters.setApplicationCode("sdk");standardCatalogParameters.setCredentialOption("Do not share");standardCatalogParameters.setUserId("admin");standardCatalogParameters.setPassword("root");standardCatalogParameters.setAutomaticGuestCustomization(false);standardCatalogParameters.setEnablePostProvisioningCustomActions(false);standardCatalogParameters.setWorkflowName("Print Number");standardCatalogParameters.setParameters(nameValuePairs);

APICatalogItem apiCatalogItem = new APICatalogItem();apiCatalogItem.setCatalogType("Standard");apiCatalogItem.setCatalogItemName("standardCatalog2");apiCatalogItem.setCatalogItemDescription("created through client code");apiCatalogItem.setCatalogIcon("VM: SUSE Linux");apiCatalogItem.setAppliedToAllGroups(false);apiCatalogItem.setGroups("Default Group");apiCatalogItem.setPublishToEndUsers(true);apiCatalogItem.setFolderName("Standard");apiCatalogItem.setStandardCatalog(standardCatalogParameters);boolean isCatalogItemCreated = false;try {isCatalogItemCreated = instance.userAPICreateCatalogItem(apiCatalogItem);} catch (Exception e) {System.out.error(e.getMessage());System.out.error("Exception occured while creating a catalog.");}System.out.println("Is Catalog Item Got Created ?"+isCatalogItemCreated);}}

Results

If the catalog item is created successfully, the result is true.

Implementation

Create an APICatalogItem by passing necessary information and then call the userAPICreateCatalogItemAPI to create the catalog item.


ExamplesCreating a Catalog Item

See Also

Retrieving Catalog Details

Deleting a Catalog Item

Retrieving Catalog DetailsObjective

Retrieve the details of a catalog using the catalog name.

Context

The catalog details are retrieved by the system administrator or the end user.

Prerequisites

• The requested catalog item must exist.

• The catalog name must be known.

REST URL/app/api/rest?formatType=json&opName=userAPIGetAllCatalogs&opData={}

Components

None

Codepublic class userAPIGetCatalogDetailsExampe{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);APIProvisionParams params = instance.userAPIGetCatalogDetails("SDKCat");System.out.println(" Catalog name "+params.getCatalogName());System.out.println(" vDC name "+params.getVdcName());}}

Results

If the catalog details are retrieved successfully, the result is true.

Implementation

Call the userAPIGetCatalogDetails API by passing the catalog name to retrieve the catalog details.


ExamplesRetrieving Catalog Details

See Also

Creating a Catalog Item

Deleting a Catalog Item

Deleting a Catalog ItemObjective

Delete a catalog item by passing the catalog name.

Context

The catalog item can be deleted by a system administrator.

Prerequisites

The catalog item to be deleted must exist.

REST URL/app/api/rest?formatType=json&opName=userAPIDeleteCatalogItem&opData={param0:"sdkCatalog"}

Components

catalogItemName—The name of the catalog item that needs to be deleted.

Codepublic class userAPIDeleteCatalogItemExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);boolean isDeleted = instance.userAPIDeleteCatalogItem("SDKCat");System.out.println("is Deleted ?"+isDeleted);}}

Results

If the catalog item is deleted successfully, the result is true.

Implementation

Call the userAPIDeleteCatalogItemAPI by passing the catalog name to delete an existing catalog item.

See Also

Creating a Catalog Item

Retrieving Catalog Details


ExamplesDeleting a Catalog Item

Managing Physical Accounts

Creating a Physical AccountObjective

Create an account for a physical asset in Cisco UCS Director. When creating an account using theXML-based API, refer to the possible values of the account category and account type parameters inthe Components section to pass valid values.

Context

Manage the physical infrastructure resources.

Prerequisites

• A site and pod must exist and reachable.

• The resources of the physical account must be reachable.

REST URL/app/api/rest?formatType=json&opName=accounts:userAPICreateInfraAccount&opData={param0:{"accountName":"Test Vmware82","podName":"Default Pod","accountCategory":-1,"accountType":"VMWare","deviceCategory":"","description":"sample","contact":"sample","destinationIPAddress":"172.29.109.82","login":"administrator","password":"cloupia123","enablePassword":"","protocol":"https","port":443,"infraAccountSupportDetailsInfo":null}}


ExamplesManaging Physical Accounts

Components


ExamplesCreating a Physical Account

• InfraAccountDetails infraAccountDetailsThe InfraAccountDetails includes the following parameters:

◦String accountName—A unique name that you assign to this account.

◦String podName—The pod to which this account belongs.

◦int accountCategory—The category of the account. The possible values of the accountcategory are:

Account CategoryInteger

Compute1

Storage2

Network3

Multi-Domain Manager or Others4

Cloud5

◦String accountType—The type of the account. You need to pass the value within quotes as"11".

The possible values of the account type are:Account TypeInteger

VMware2

HYPERV6

REDHAT_KVM9

XENDESKTOP10

UCSM11

NETAPP12

NETAPP_DFM14

HP15

CISCO_CIMC16

EMC_VNX17

IPMI18



Account TypeInteger

19 LOAD_BALANCERS

EMC_VMAX20

EMC_VPLEX24

WHIPTAIL22

EMC_ISILON23

EMC_NEW_VNX25

EMC_NEW_VNX_BLOCK26

EMC_NEW_VNX_UNIFIED27

HP_OA28

CAT_LDAP29

CAT_LDAP_CLEANUP30

VCE_VISION_IO31

EMC_RECOVERPOINT32

UCS_INVICTA_APPLIANCE33

UCS_INVICTA_SCALING34

EMC_NEW_VNX_BLOCK_HTTP35

EMC_VNXE36

◦String deviceCategory—The category of the device, including Compute, Storage, andNetwork.

◦String description—Optional. A description of this account.

◦String contact—Optional. The email address that you can use to contact the administratoror other person responsible for this account.

◦String destinationIPAddress—The destination IP address of this account. You need to passthe IP address within quotes.

◦String login—The login ID that this account will use to access element manager. For instance,the Cisco UCSManager account will use this login ID to access Cisco UCSManager . Thisusername must be a valid account in Cisco UCS Manager .



◦String password—The password associated with the login ID.

◦String enablepassword—Optional. Pass the value as true to enable password for this account.

◦String protocol—The protocol to use to communicate with the account. The possible valuesare Telnet and SSH.

◦int port—The port that is used to access the element manager.

◦infraAccountSupportDetailsInfo—Details of the infra account. TheinfraAccountSupportDetailsInfo includes the following parameters:

◦String spAIpAddress—Optional. The IP address for Storage Processor A of the VNXdevice.

◦String spBIpAddress—Optional. The IP address for Storage Processor B of the VNXdevice.

◦String blockAccessUserName—Optional. The username for block access of the VNXdevice.

◦String blockAccessPwd—Optional. The password for block access of the VNX device.

◦String sshIpAddress—Optional. The IP address of the SSH server. You need to passthe IP address within quotes.

◦String sshUsername—Optional. The username that this account will use to access theSSH server.

◦String sshPassword—Optional. The password associated with the SSH username.

◦int sshPort—Optional. The port used to access the SSH server.

◦String domain—Optional. The domain that is associated with the account.

◦String serviceProvider—Optional. The name of the service provider associated withthis account, if any.

Codepublic class UserAPICreateInfraAccountExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.187",

"6C6416AD90704DF495A6B4D0A75A0BB1", "https", 443);UserAPIAccounts instance = new UserAPIAccounts(server);InfraAccountDetails infraAccountDetails = new InfraAccountDetails();infraAccountDetails.setAccountName("AccName");infraAccountDetails.setPodName("PodName");infraAccountDetails.setAccountCategory(2);infraAccountDetails.setAccountType("11");infraAccountDetails.setProtocol("http");infraAccountDetails.setPort(80);infraAccountDetails.setDestinationIPAddress("172.29.32.14");infraAccountDetails.setLogin("admin");infraAccountDetails.setPassword("admin");boolean isCreated = instance.userAPICreateInfraAccount(infraAccountDetails);System.out.println("is Account Created ?"+isCreated);}}



Results

A physical account is created. The return value is true if creation is successful.

Implementation

Create an instance of InfraAccountDetails object with account information and then calluserAPICreateInfraAccount to create the physical account.

See Also

Listing the Accounts

Deleting a Physical Account

Listing the AccountsObjective

Retrieve the physical and virtual accounts in Cisco UCS Director.

Context

Identify the existing resources or accounts in Cisco UCS Director.

Prerequisites

User must have permission to view all the accounts in Cisco UCS Director.

REST URL/app/api/rest?formatType=json&opName=accounts:userAPIGetAllPhysicalInfraAccounts&opData={}

Components

None

Codepublic class UserAPIGetAllAccountsExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIAccounts instance = new UserAPIAccounts(server);List<String> accountNameList = instance.userAPIGetAllAccounts();for (int i = 0; i < accountNameList.size(); ++i){System.out.println("Name "+accountNameList.get(i));}}

}

Results

The list of physical and virtual accounts is displayed.


ExamplesListing the Accounts

Implementation

To retrieve the existing physical and virtual account details, call the userAPIGetAllAccounts API.

See Also

Creating a Physical Account

Deleting a Physical Account

Deleting a Physical AccountObjective

Delete a physical account from Cisco UCS Director.

Context

The physical account can be deleted by a user belonging to the group to which the account is mapped.

Prerequisites

The physical account must be available.

REST URL/app/api/rest?formatType=json&opName=accounts:userAPIDeleteInfraAccount&opData={param0:"UCSM-150"}

Components

String Account name—The name of the physical account that needs to be deleted.

Codepublic class UserAPIDeleteInfraAccountExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIAccounts instance = new UserAPIAccounts(server);boolean isDeleted = instance.userAPIDeleteInfraAccount("UCSAccount");System.out.println("Is the Account deleted ? :" + isDeleted);}}

Results

If the physical account is deleted successfully, the result is true.

Implementation

Call the userAPIDeleteInfraAccount API by passing the physical account name to delete an existingphysical account.


ExamplesDeleting a Physical Account

See Also

Creating a Physical Account

Listing the Accounts

Managing Virtual Data Centers

Creating a VDCObjective

Create a virtual data center (VDC) from which the VM will be provisioned.

Context

Create a VDC to provision a VM.

Prerequisites

Cloud and group must exist.

REST URL/app/api/rest?formatType=json&opName=userAPICreateVDC&opData={param0:{"vdcName":"Vdc","vdcDescription":"VDC","cloudName":"VMware-Cloud","groupName":2,"approver1":"","approver2":"","vdcSupportEmail":"[email protected]","vdcCustomerNoticationEmail":"","systemPolicy":"VmwareCloudSysPolicy","deploymentPolicy":"","slaPolicy":"","computingPolicy":"","storagePolicy":"","networkPolicy":"","costModel":"","isLocked":false,"isDeletable":false,"inactivityPeriodForDeletion":1000}}

Components

APIVDCDetails


ExamplesManaging Virtual Data Centers

Codepublic class CreateVDCExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);APIVDCDetails vdcDetails = new APIVDCDetails();vdcDetails.setVdcName("Vdc");vdcDetails.setVdcDescription("VDC");vdcDetails.setCloudName("VMware-Cloud");vdcDetails.setGroupName(2);vdcDetails.setApprover1("");vdcDetails.setApprover2("");vdcDetails.setVdcSupportEmail("[email protected]");vdcDetails.setVdcCustomerNoticationEmail("");//System policy is optionalvdcDetails.setSystemPolicy("VmwareCloudSysPolicy");//System policy is optionalvdcDetails.setSlaPolicy("");//System policy is optionalvdcDetails.setComputingPolicy("");//netowrk policy is optionalvdcDetails.setNetworkPolicy("");//storage policy is optionalvdcDetails.setStoragePolicy("");//Cost model is optionalvdcDetails.setCostModel("");//vdc locked is optionalvdcDetails.setLocked(false);//Deletable is optionalvdcDetails.setDeletable(false);vdcDetails.setInactivityPeriodForDeletion(1000);boolean isVDCCreated = instance.userAPICreateVDC(vdcDetails);System.out.println("is VDC Created "+isVDCCreated);}}

Results

If the VDC is created successfully, the result is true.

Implementation

Create an APIVDCDetails by passing necessary information and then call the userAPICreateVDC tocreate a VDC.

See Also

Listing the VDCs

Exporting a VDC

Importing a VDC

Retrieving VDC Resource Limits, on page 25

Retrieving a Cost Model, on page 26

Deleting a VDC


ExamplesCreating a VDC

Listing the VDCsObjective

Retrieve a list of VDCs in a user group.

Context

Retrieve a list of VDCs in a group to choose the required VDC when provisioning VMs.

Prerequisites

The logged-in user must be assigned to the group.

REST URL/app/api/rest?formatType=json&opName=userAPIGetAllVDCs&opData={}

Components

None

Codepublic class UserAPIGetAllVDCExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);APITabularReport tabularReport = instance.userAPIGetAllVDCs();System.out.println(“No. Of VDC :”+tabularReport.getRowCount());System.out.println(“No. Of Column : ”+tabularReport.getColumnMetaData());}

}

Results

The list of VDCs in the user group is returned.

Implementation

Call the userAPIGetAllVDCs API to retrieve all the VDCs in a user group.

See Also

Creating a VDC

Exporting a VDC

Importing a VDC



Deleting a VDC


ExamplesListing the VDCs

Exporting a VDCObjective

Export a VDC from the Cisco UCS Director server to the local system.

Context

Create a same set of VDC in another Cisco UCS Director server.

Prerequisites

The name of the VDC that you want to export.

REST URL/app/api/rest?formatType=json&opName=userAPIExportVDC&opData={param0:"vDCIT"}

Components

vdcName—The name of the VDC that you want to export.

Codepublic class ExportVDCExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);String exportVDCString = instance.userAPIExportVDC("sample_VDC");System.out.println("Export VDC as "+exportVDCString);}}

Results

The sample_VDC VDC is exported to local system.

Implementation

Use the userAPIExportVDC API and pass the VDC name to export the VDC to the local system.

See Also

Listing the VDCs

Creating a VDC

Importing a VDC



Deleting a VDC


ExamplesExporting a VDC

Importing a VDCObjective

Import a VDC into Cisco UCS Director from the local system.

Context

Import external VDC into Cisco UCS Director.

Prerequisites

The VDC that needs to be imported must be available in the local system.

REST URL/app/api/rest?formatType=json&opName=userAPIImportVDC&opData={param0:"importvdcasstring"}

Components

vdcName—The name of the VDC that you want to import.

Codepublic class ImportVDCExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);//You have to pass the exported VDC String as importVDC parameterVDC vdcObject = instance.userAPIImportVDC("exportVDCAsString" );System.out.println("VDC Name = "+vdcObject.getVdcName());}}

Results

The imported VDC appears in Cisco UCS Director.

Implementation

Call the userAPIImportVDCAPI and pass the VDC name to import the VDC into Cisco UCS Director.

See Also

Creating a VDC

Listing the VDCs

Exporting a VDC



Deleting a VDC


ExamplesImporting a VDC

Retrieving VDC Resource LimitsObjective

Retrieve the resource limits of a VDC.

Context

Identify the used resource limits of a VDC.

Prerequisites

Container or VDC must be defined.

REST URL

Request/app/api/rest?formatType=json&opName=userAPIGetVDCResourceLimits&opData={param0:"bmtest"}Response{ "serviceResult":{"provisionedNoOfvCPUsLimit":0,"provisionedMemGBLimit":0.0,"provisionedDiskGBLimit":0.0,"halfWidthPhysicalServerLimit":0,"fullWidthPhysicalServerLimit":0},

"serviceError":null, "serviceName":"InfraMgr", "opName":"fenced:userAPIGetVDCResourceLimits"}

Components

None

Codepublic class GetVDCResourceLimits{public static void main(String[] args) throws Exception{CuicServer api = CuicServer.getAPI("172.29.110.241",

"EDDF69C4D9AA4E4FA8F14EFD57B90402", "http", 80);UserAPIFencedContainer fenced = new UserAPIFencedContainer(api);APIResourceLimitParams params = new APIResourceLimitParams();params.setVdcName("bmtest");APIResourceLimitResponse response = fenced.userAPIGetVDCResourceLimits(params);System.out.println( " Response is \n Full Width

Limits"+response.getFullWidthPhysicalServerLimit());System.out.println( " Half Width Limits"+response.getHalfWidthPhysicalServerLimit());

System.out.println( " Provisioned Disk GB "+response.getProvisionedDiskGBLimit());System.out.println( " Provisioned Memory"+response.getProvisionedMemGBLimit());System.out.println( " Provisioned vCPU Limits

"+response.getProvisionedNoOfvCPUsLimit());}}

Results

The following resource limits of the VDC are displayed: full width limits, half width limits, provisioneddisk, provisioned memory, and provisioned vCPU limits.


ExamplesRetrieving VDC Resource Limits

Implementation

Use the userAPIGetVDCResourceLimits API and pass the VDC name to view the resource limitsconfiguration.

See Also

Creating a VDC, on page 20

Listing the VDCs

Exporting a VDC

Importing a VDC


Deleting a VDC

Retrieving a Cost ModelObjective

Retrieve the cost model for the resources available in the VDC.

Context

Retrieve the one time and monthly cost model of the VM and physical server for the given resources(for example, CPU, memory, and disk).

Prerequisites

VDC and cost model must exist.

REST URL

Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetCostModel&opData={param0:{"vdcName":"CostModel_Vdc","costModelResources":[{"name":"CPU","value":"1"},{"name":"Memory","value":"1"},{"name":"Disk","value":"1"},{"name":"NetworkRx","value":"1"},{"name":"NetworkTx","value":"1"},{"name":"BMCPU","value":"1"},{"name":"BMMemory","value":"1"},{"name":"BMDisk","value":"1"},{"name":"BladeType","value":"Half"}]}}Response{ "serviceResult":{"costModelRequestedInfo":{"vDC Name":"CostModel_Vdc","Memory (GB)":"1","Disk (GB)":"1","NetworkRx (GB)":"1","NetworkTx (GB)":"1","CPU (GHz)":"1","BMMemory (GB)":"1","BMDisk (GB)":"1","Blade Type":"Half","BMCPU (Cores)":"1"},"vmCostModel":{"oneTimeItemCost":100.0,"monthlyCost":2180.0,"cpuCostModel":{"cpuGhzCostPerHour":1.0,"cpuCostPerCore":0.0,"totalCPUCost":720.0},"diskCostModel":{"diskGBCostPerHour":1.0,"totalDiskCost":720.0},"memoryCostModel":{"memoryGBCostPerHour":1.0,"totalMemoryCost":720.0},"networkCostModel":{"netRxCostPerGB":10.0,"netTxCostPerGB":10.0,"totalNetworkCost":20.0}},"bMCostModel":{"oneTimeItemCost":100.0,"monthlyCost":2880.0,"cpuCostModel":{"cpuGhzCostPerHour":0.0,"cpuCostPerCore":1.0,"totalCPUCost":720.0},"diskCostModel":{"diskGBCostPerHour":1.0,"totalDiskCost":720.0},"memoryCostModel":{"memoryGBCostPerHour":1.0,"totalMemoryCost":720.0},"bladeCostModel":{"fullBladeCostPerHour":0.0,"halfBladeCostPerHour":1.0,"totalBladeCost":720.0}}},"serviceError":null, "serviceName":"InfraMgr", "opName":"chargeback:userAPIGetCostModel"}


ExamplesRetrieving a Cost Model

Components

• VdcName—The name of the VDC.

The possible name:value pairs are:

• CPU—Optional. The provisioned CPU limit in GHz or cores.

• Memory—Optional. The provisioned memory limit in GB.

• NetworkRx—Optional. The rate at which the traffic data is received.

• NetworkTx—Optional. The rate at which the traffic data is transmitted.

• Disk—Optional. The provisioned disk limit in GB.

• BMCPU—Optional. The provisioned CPU limit of BM in GHz or cores.

• BMMemory—Optional. The provisioned BM memory limit in GB.

• BMDisk—Optional. The provisioned disk limit of BM in GB.

• BladeType—Optional. The type of the blade.



Codepublic class GetCostModel{public static void main(String[] args)throws Exception{CuicServer server = CuicServer.getAPI("<IP address>",

"<REST Key>", "https", 443);UserAPIChargeBack instance = new UserAPIChargeBack(api);List<APINameValue> requestParam = new ArrayList<APINameValue>();APIGetCostModelParams costParams = new APIGetCostModelParams();costParams.setVdcName("CostModel_Vdc");APINameValue value=new APINameValue();

value.setName("CPU");value.setValue("1");requestParam.add(value);value=new APINameValue();value.setName("Memory");value.setValue("1");requestParam.add(value);value=new APINameValue();value.setName("Disk");value.setValue("1");requestParam.add(value);value=new APINameValue();value.setName("NetworkRx");value.setValue("1");requestParam.add(value);value=new APINameValue();value.setName("NetworkTx");value.setValue("1");value=new APINameValue();value.setName("BMCPU");value.setValue("1");requestParam.add(value);costParams.setCostModelResources(requestParam);APIGetCostModelResponse response = instance.userAPIGetCostModel(costParams);APIVMCostModel vmCostModel = response.getVmCostModel();APIPhysicalServerCostModel bmCostModel = response.getBMCostModel();if(vmCostModel != null){System.out.println(vmCostModel.getOneTimeItemCost());APICPUCostModel cpuModel = vmCostModel.getCpuCostModel();System.out.println(cpuModel.getTotalCPUCost());}if(bmCostModel != null){System.out.println(bmCostModel.getOneTimeItemCost());APICPUCostModel bmCPUModel = bmCostModel.getCpuCostModel();

System.out.println(bmCPUModel.getTotalCPUCost());}}}

Results

The cost model of resources in VM and physical server are displayed.

Implementation

Call the userAPIGetCostModel API and pass the VDC name along with the resources for which youwant to see the cost model.



See Also

Creating a VDC, on page 20

Listing the VDCs, on page 22

Exporting a VDC, on page 23

Importing a VDC, on page 24


Deleting a VDC, on page 29

Deleting a VDCObjective

Delete a VDC from Cisco UCS Director.

Context

Remove a VDC which is not in use, from Cisco UCS Director.

Prerequisites

The logged-in user must have permission to delete a VDC.

REST URLNot Applicable

Components

vdcName—The name of the VDC that you want to delete.

Codepublic class DeleteVDCExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);DeleteVDCConfig instance = new DeleteVDCConfig(server);instance.setVdcName("");instance.setRollbackRequest(false);boolean isDeleted = instance.execute();System.out.println(" is VDC Deleted "+isDeleted);}}

Results

If the VDC is deleted successfully, the result is true.

Implementation

Delete a VDC by passing the VDC name.


ExamplesDeleting a VDC

See Also

Creating a VDC

Listing the VDCs

Exporting a VDC

Importing a VDC



Managing Virtual Infrastructure Policies

Creating a Virtual Infrastructure PolicyObjective

Create a virtual infrastructure policy for a fenced virtual application container. The virtual infrastructurepolicy defines which VM to use and what type of container you want to provision. This policy alsodefines which PNSC account you want to tie to this particular account.

Context

The virtual infrastructure policy is used for creating application container template. With this template,you can create application containers for use in a variety of networks (including DFA Networks).

Prerequisites

The VMware virtual account must exist.

REST URL

Request/app/api/rest?formatType=json&opName=fenced:userAPICreateServiceContainerVirtualInfraPolicy&opData={param0:{"policyName":"vipFenc","policyDescription":"","virtualAccountName":"vc117","isGatewayRequired":false,"gatewayPolicyName":"","isF5LoadBalancerRequired":false,"f5LoadBalancerPolicyName":""}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"fenced:userAPICreateServiceContainerVirtualInfraPolicy" }


ExamplesManaging Virtual Infrastructure Policies

Components

• policyName—The name of the virtual infrastructure policy.

• policyDescription—Optional. The description of the virtual infrastructure policy.

• virtualAccountName—The name of the virtual account for which you define the virtualinfrastructure policy.

• isGatewayRequired—Set the parameter as True if gateway is required for the fenced container.

• gatewayPolicyName—If the isGatewayRequired parameter is set as True, provide the gatewaypolicy name.

• isF5LoadBalancerRequired—Set the parameter asTrue if the F5 load balancer service is required.

• f5LoadBalancerPolicyName—If the isF5LoadBalancerRequired parameter is set asTrue, providethe F5 load balancer policy name.

Codepublic class FencedContainerVirtualInfraPolicyCreateExample{public static void main(String[] args) throws Exception{

CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);

UserAPIFencedContainer instance = new UserAPIFencedContainer(server);FencedContainerVirtualInfrastructurePolicy policy = new

FencedContainerVirtualInfrastructurePolicy();policy.setPolicyName("VIPolicy");policy.setPolicyDescription("VIPolicy1 Description");policy.setVirtualAccountName("vm117");policy.setGatewayRequired(false);policy.setF5LoadBalancerRequired(false);boolean obj = instance.userAPICreateServiceContainerVirtualInfraPolicy( policy );System.out.println("Created Sucessfuly : "+obj);

}}

Results

Returns True after successful addition of the virtual infrastructure policy.

Implementation

Call the userAPICreateServiceContainerVirtualInfraPolicy API and pass the virtual account name alongwith the necessary details.

See Also

Retrieving a Virtual Infrastructure Policy

Modifying a Virtual Infrastructure Policy

Deleting a Virtual Infrastructure Policy


ExamplesCreating a Virtual Infrastructure Policy

Retrieving a Virtual Infrastructure PolicyObjective

Retrieve the details of a virtual infrastructure policy by passing the policy name.

Context

To view the set policy details.

Prerequisites

The virtual infrastructure policy must exist.

REST URL

Request/app/api/rest?formatType=json&opName=fenced:userAPIGetServiceContainerVirtualInfraPolicy&opData={param0:"vipPolicy"}

Response{ "serviceResult":[{"policyId":2,"policyName":" vipPolicy ","policyDescription":"","containerType":"Fenced Virtual","account":"V100","vnmcConfig":{"vnmcAccount":null,"vnmcFirewallPolicies":null},"apicConfig":{"applicationProfile":null},"gatewayConfig":{"gatewayRequired":false,"gatewayPolicy":"","summaryArea":null,"gatewayType":"No Gateway"},"f5LBConfig":{"f5LoadBalancerRequired":false,"f5LoadBalancerPolicy":"","summaryArea":null,"f5LoadBalancerType":"No F5 Load Balancer"},"dfaConfig":{"vsgEnabled":false,"accountId":"","switchType":"","switchName":"","alternateSwitchName":"","serviceNetworkConfiguration":null,"l3Network":false,"fabricOrganization":"","fabricPartition":"","fabricNetwork":null,"serviceNetworkMobilityDomain":null,"autoServiceNetworkMobilityDomain":true,"hostNetworkConfiguration":null,"mobilityDomain":null,"autoSelectMobilityDomain":true,"partitionParamsLabel":null,"dciID":null,"extendPrtnAcrossFabric":true,"serviceNodeIpAddress":null,"dnsServer":null,"secondaryDNSServer":null,"multiCastGroupAddress":null,"profileName":"None","profileParamsLabel":null,"includeBorderLeafRt":null},"fabricASAConfig":{"ipSubnetPoolPolicy":null,"internalConfigurationLabel":null,"internalNetworkName":null,"internalNetworkRole":null,"internalNetworkGatewayIP":null,"internalNetworkMask":null,"internalNetworkProfile":null,"internalNetworkMobilityDomain":null,"autoSelectInternalNetworkMobilityDomain":true,"externalConfigurationLabel":null,"externalPartitionProfile":null,"externalNetworkName":null,"externalNetworkRole":null,"externalNetworkGatewayIP":null,"externalNetworkMask":null,"externalNetworkProfile":null,"externalNetworkMobilityDomain":null,"autoSelectExternalNetworkMobilityDomain":true},"fabricASAvConfig":{"ipSubnetPoolPolicy":null,"internalConfigurationLabel":null,"internalNetworkName":null,"internalNetworkRole":null,"internalNetworkGatewayIP":null,"internalNetworkMask":null,"internalNetworkProfile":null,"internalSwitchType":"","internalSwitchName":"","internalNetworkMobilityDomain":null,"autoSelectInternalNetworkMobilityDomain":true,"externalConfigurationLabel":null,"externalPartitionProfile":null,"externalNetworkName":null,"externalNetworkRole":null,"externalNetworkGatewayIP":null,"externalNetworkMask":null,"externalNetworkProfile":null,"externalSwitchType":"","externalSwitchName":"","externalNetworkMobilityDomain":null,"autoSelectExternalNetworkMobilityDomain":true},"fabricF5Config":{"serviceConfigurationLabel":null,"serviceNetworkName":null,"serviceNetworkRole":null,"serviceNetworkGatewayIP":null,"serviceNetworkMask":null,"serviceNetworkProfile":null,"f5ServiceNetworkMobilityDomain":null,"autoSelectServiceNetworkMobilityDomain":true}}], "serviceError":null,"serviceName":"InfraMgr", "opName":"fenced:userAPIGetServiceContainerVirtualInfraPolicy"}

Components

policyName—The name of the virtual infrastructure policy.


ExamplesRetrieving a Virtual Infrastructure Policy

Codepublic class retrieveAPI{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("10.23.210.118","ADFGLKJSHFJ23478234HJBFJGH","https", 443);UserAPIFencedContainer instance = new UserAPIFencedContainer(server);List obj = instance.userAPIGetServiceContainerVirtualInfraPolicy( "x" );System.out.println(obj);}}

Results

If the policy details are retrieved successfully, the result is true.

Implementation

Call the userAPIGetServiceContainerVirtualInfraPolicy API and pass the virtual infrastructure policyname.

See Also

Creating a Virtual Infrastructure Policy



Modifying a Virtual Infrastructure PolicyObjective

Update the virtual infrastructure policy of a fenced container with the given details. The policy namecannot be edited.

Context

To update the policy of virtual infrastructure defined for a container. The updated policy is used forcreating a new application container template.

Prerequisites



ExamplesModifying a Virtual Infrastructure Policy

REST URL

Request/app/api/rest?formatType=json&opName=fenced:userAPIUpdateServiceContainerVirtualInfraPolicy&opData={param0:{"policyName":"Testing","policyDescription":"Testing Update Description ","virtualAccountName":"VNX_Cloud169","isGatewayRequired":false,"gatewayPolicyName":"","isF5LoadBalancerRequired":false,"f5LoadBalancerPolicyName":""}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"fenced:userAPIUpdateServiceContainerVirtualInfraPolicy" }

Components


• policyDescription—Optional. The description of the virtual infrastructure policy.

• virtualAccountName—The name of the virtual account for which you define the virtualinfrastructure policy.

• isGatewayRequired—Set the parameter as True if gateway is required for the fenced container.

• gatewayPolicyName—If the isGatewayRequired parameter is set as True, provide the gatewaypolicy name.

• isF5LoadBalancerRequired—Set the parameter asTrue if the F5 load balancer service is required.

• f5LoadBalancerPolicyName—If the isF5LoadBalancerRequired parameter is set asTrue, providethe F5 load balancer policy name.

Codepublic class FencedContainerVirtualInfraPolicyUpdateExample{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);

UserAPIFencedContainer instance = new UserAPIFencedContainer(server);FencedContainerVirtualInfrastructurePolicy policy = new

FencedContainerVirtualInfrastructurePolicy();policy.setPolicyName("VIPolicy");policy.setPolicyDescription("VIPolicy1 Description modified");policy.setVirtualAccountName("vm117");policy.setGatewayRequired(false);policy.setF5LoadBalancerRequired(false);boolean obj = instance.userAPIUpdateServiceContainerVirtualInfraPolicy( policy );System.out.println("Created Sucessfuly : "+obj);

}}

Results

If the virtual infrastructure policy is updated successfully, the result is true.

Implementation

Call the userAPIUpdateServiceContainerVirtualInfraPolicy API, and pass the virtual infrastructurepolicy name and virtual account name along with the necessary details that need to be updated.


ExamplesModifying a Virtual Infrastructure Policy

See Also




Deleting a Virtual Infrastructure PolicyObjective

Delete a virtual infrastructure policy from Cisco UCS Director.

Context

A user belonging to a group, can delete the virtual infrastructure policy.

Prerequisites


REST URL

Request/app/api/rest?formatType=json&opName=fenced:userAPIDeleteServiceContainerVirtualInfraPolicy &opData={param0:{"policyName":"vipFenc”}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"fenced:userAPIDeleteServiceContainerVirtualInfraPolicy" }

Components


Codepublic class DeleteServiceContainerVirtualInfraPolicy{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);UserAPIFencedContainer instance = new UserAPIFencedContainer(server);FencedContainerVirtualInfrastructurePolicy policy = newFencedContainerVirtualInfrastructurePolicy();policy.setPolicyName("VIPolicy");boolean obj = instance.userAPIDeleteServiceContainerVirtualInfraPolicy( policy );System.out.println(obj);}}

Results

If the virtual infrastructure policy is deleted successfully, the result is true.


ExamplesDeleting a Virtual Infrastructure Policy

Implementation

Call the userAPIDeleteServiceContainerVirtualInfraPolicy API and pass the virtual infrastructure policyname.

See Also




Managing APIC Virtual Infrastructure Policies

Creating an APIC Virtual Infrastructure PolicyObjective

Create a virtual infrastructure policy for an APIC container.

Context

The virtual infrastructure policy is used for creating a service container template.

Prerequisites

The virtual account must exist.

REST URL

Request/app/api/rest?formatType=json&opName=apic:userAPICreateServiceContainerVirtualInfraPolicy&opData={param0:{"policyName":"VIPolicy1","policyDescription":"Create VIP Policy","containerType":"APIC","applicationProfileName":" appprofile"}}

Response on successful execution of the API{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPICreateServiceContainerVirtualInfraPolicy" }

Response on unsuccessful execution of the API

If the application profile specified in the REST URL does not exist, the API throws the followingexception. The exception suggests user to use a valid application profile name or to use theuserAPICreateApplicationProfile API to create a new application profile.{ "serviceResponse":null, "serviceError":"REMOTE_SERVICE_EXCEPTION:Application profile test does not exist, Please use userAPICreateApplicationProfileapi to create new application profile.", "serviceName":"InfraMgr","opName":"apic:userAPICreateServiceContainerVirtualInfraPolicy" }


ExamplesManaging APIC Virtual Infrastructure Policies

Components


• containerType—The type of the container must be APIC.

• applicationProfileName—The name of the application profile that you want to use for creatingthe container.

Codepublic class APICContainerVirtualInfraPolicyCreateExample{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);UserAPIAPICContainer instance = new UserAPIAPICContainer(server);APICContainerVirtualInfraStructurePolicy policy = new

APICContainerVirtualInfraStructurePolicy();policy.setPolicyName("VIPolicy1");policy.setPolicyDescription("VIPolicy1 Description");policy.setApplicationProfileName("applicationProfileName");boolean obj = instance.userAPICreateServiceContainerVirtualInfraPolicy(policy);System.out.println("Created Sucessfuly : " + obj);

/*** Update the service Container Virtual Infra Policy*/

obj = instance.userAPIUpdateServiceContainerVirtualInfraPolicy(policy);System.out.println(obj); }

}

Results

If the virtual infrastructure policy is added successfully, the result is true.

Implementation

Call the userAPICreateServiceContainerVirtualInfraPolicy API and pass the application profile namealong with the necessary details.

See Also

Listing All APIC Virtual Infrastructure Policy

Retrieving an APIC Virtual Infrastructure Policy

Modifying an APIC Virtual Infrastructure Policy

Deleting an APIC Virtual Infrastructure Policy

Listing All APIC Virtual Infrastructure PolicyObjective

Retrieve all APIC virtual infrastructure policies in Cisco UCS Director.


ExamplesListing All APIC Virtual Infrastructure Policy

Context

To get a list of APIC virtual infrastructure policies in Cisco UCS Director.

Prerequisites

The requesting user must be authorized to get the list of APIC virtual infrastructure policies.

REST URL/app/api/rest?formatType=json&opName=apic:userAPIGetAllServiceContainerVirtualInfraPolicies&opData={}

Components

None

Codepublic class GetAllAPICContainerVirtualInfraPolicies{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);UserAPIAPICContainer instance = new UserAPIAPICContainer(server);List<APICContainerVirtualInfraStructurePolicy> list =

instance.userAPIGetAllServiceContainerVirtualInfraPolicies();for (Iterator iterator = list.iterator(); iterator.hasNext();) {APICContainerVirtualInfraStructurePolicy apicContainerVirtualInfraStructurePolicy =(APICContainerVirtualInfraStructurePolicy) iterator.next();System.out.println(" Profile Name :

"+apicContainerVirtualInfraStructurePolicy.getPolicyName());System.out.println(" Profile Description :

"+apicContainerVirtualInfraStructurePolicy.getPolicyDescription());System.out.println(" Application Profile Name :

"+apicContainerVirtualInfraStructurePolicy.getApplicationProfileName());}

}

Results

The API returns the list of APIC virtual infrastructure policies in Cisco UCS Director.

Implementation


See Also

Creating an APIC Virtual Infrastructure Policy





ExamplesListing All APIC Virtual Infrastructure Policy

Retrieving an APIC Virtual Infrastructure PolicyObjective

Retrieve the details of a virtual infrastructure policy by passing the policy name.

Context

To view the set policy details.

Prerequisites


REST URL/app/api/rest?formatType=json&opName=apic:userAPIGetServiceContainerVirtualInfraPolicy&opData={param0:"testPolicy"}

Components

• policyName—The name of the virtual infrastructure policy that you want to delete.

Codepublic class GetAPICContainerVirtualInfraPolicyExample{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);UserAPIAPICContainer instance = new UserAPIAPICContainer(server);List<APICContainerVirtualInfraStructurePolicy> list =

instance.userAPIGetServiceContainerVirtualInfraPolicy("apicPolicy");for (Iterator iterator = list.iterator(); iterator.hasNext();) {APICContainerVirtualInfraStructurePolicy apicContainerVirtualInfraStructurePolicy

= (APICContainerVirtualInfraStructurePolicy) iterator.next();

System.out.println(" Profile Name :"+apicContainerVirtualInfraStructurePolicy.getPolicyName());

System.out.println(" Profile Description :"+apicContainerVirtualInfraStructurePolicy.getPolicyDescription());

System.out.println(" Application Profile Name :"+apicContainerVirtualInfraStructurePolicy.getApplicationProfileName());

}}

Results

If the policy details are retrieved successfully, the result is true.

Implementation

Call the userAPIGetServiceContainerVirtualInfraPolicy API and pass the virtual infrastructure policyname.


ExamplesRetrieving an APIC Virtual Infrastructure Policy

See Also





Modifying an APIC Virtual Infrastructure PolicyObjective

Update the virtual infrastructure policy of an APIC container with the given details. The policy namecannot be edited.

Context

To update the policy of virtual infrastructure defined for an APIC container. The updated policy is usedfor creating a new service container template.

Prerequisites

The APIC virtual infrastructure policy must exist.

REST URL/app/api/rest?formatType=json&opName=apic:userAPIUpdateServiceContainerVirtualInfraPolicy&opData={param0"policyName":"testPolicy","policyDescription":"updated testPolicy ","containerType":"APIC","applicationProfileName":"appprofile"}}

Response on successful execution of the API{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPIUpdateServiceContainerVirtualInfraPolicy" }

Response on unsuccessful execution of the API

If the application profile specified in the REST URL does not exist, the API throws the followingexception which suggests using a valid application profile name.{ "serviceResponse":null, "serviceError":"REMOTE_SERVICE_EXCEPTION:Application profile ghfgh does not exist, Please provide availableapplication profile name", "serviceName":"InfraMgr","opName":"apic:userAPIUpdateServiceContainerVirtualInfraPolicy" }

Components


• containerType—The type of the container must be APIC.

• applicationProfileName—The name of the application profile that you want to use for creatingthe container.


ExamplesModifying an APIC Virtual Infrastructure Policy

Codepublic class APICContainerVirtualInfraPolicyUpdateExample{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);UserAPIAPICContainer instance = new UserAPIAPICContainer(server);APICContainerVirtualInfraStructurePolicy policy = newAPICContainerVirtualInfraStructurePolicy();policy.setPolicyName("VIPolicy1");policy.setPolicyDescription("VIPolicy1 Description");policy.setApplicationProfileName("applicationProfileName");/*** Update the service Container Virtual Infra Policy*/boolean obj = instance.userAPIUpdateServiceContainerVirtualInfraPolicy(policy);System.out.println(obj);

}}

Results

If the virtual infrastructure policy is updated successfully, the result is true.

Implementation

Call the userAPIUpdateServiceContainerVirtualInfraPolicy API, and pass the virtual infrastructurepolicy name along with the necessary details that you want to be updated.

See Also





Deleting an APIC Virtual Infrastructure PolicyObjective

Delete an APIC virtual infrastructure policy from Cisco UCS Director.

Context

A user belonging to the group to which the virtual account is mapped, can delete the virtual infrastructurepolicy.

Prerequisites



ExamplesDeleting an APIC Virtual Infrastructure Policy

REST URL/app/api/rest?formatType=json&opName=apic:userAPIDeleteServiceContainerVirtualInfraPolicy&opData={param0:{"policyName":"apicPolicy”}

Components

• policyName—The name of the virtual infrastructure policy that you want to delete.

Codepublic class APICContainerVirtualInfraPolicyDeleteExample{public static void main(String[] args) throws Exception {CuicServer server =CuicServer.getAPI("172.22.234.33","EF0FE312B5444E7B8DE4836DDC55F4A0", "https", 443);CuicServer server = CuicServer.getAPI("<IP address>", "<REST Key>", "https", 443);UserAPIAPICContainer instance = new UserAPIAPICContainer(server);APICContainerVirtualInfraStructurePolicy policy = newAPICContainerVirtualInfraStructurePolicy();policy.setPolicyName("apicPolicy");

boolean isDeleted = instance.userAPIDeleteServiceContainerVirtualInfraPolicy(policy);

System.out.println("is Policy Deleted ?"+isDeleted);}}

Results

If the APIC virtual infrastructure policy is deleted successfully, the result is true.

Implementation

Call the userAPIDeleteServiceContainerVirtualInfraPolicy API and pass the virtual infrastructure policyname.

See Also





Managing Service Containers

Creating a Service Container with TemplateObjective

Create a service container using a template.


ExamplesManaging Service Containers

Context

Create a container using a template to provision a VDC or VM.

Prerequisites

• The logged-in user must have permission to create a service container.

• The container template must be available in Cisco UCS Director.

REST URL/app/api/rest?formatType=json&opName=fenced:userAPICreateServiceContainerWithoutCatalog&opData={param0:"SDKCont",param1:2,param2:"SDKContTemplate"}

Components

The container template is required.

Codepublic class CreateServiceContainerExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIAPICContainer instance = new UserAPIAPICContainer(server);int srId = instance.userAPICreateServiceContainerWithoutCatalog("SDKCont", 2,"SDKContTemplate");System.out.println(" Service Container Request id "+srId);}}

Results

The service request ID for creating service container is returned.

Implementation

Call the userAPICreateServiceContainerWithoutCatalog API and pass the container name, group ID,and container template to create a service container.

See Also

Retrieving a Service Container

Retrieving a Service Container with Catalog

Listing all Service Containers in Cisco UCS Director

Adding a Tier to a Container VM

Adding a Virtual Network Interface Card to a Container VM

Deleting a Service Container


ExamplesCreating a Service Container with Template

Retrieving a Service ContainerObjective

Retrieve the details of a service container from Cisco UCS Director.

Context

Identify the container availability to provision a VDC or VM.

Prerequisites

The ID of the service container must be known.

REST URL/app/api/rest?formatType=json&opName=fenced:userAPIGetServiceContainerData&opData={param0:2}

Components

Service container id—The ID of the service container for which you need to view the details.

Codepublic class GetServiceContainerDataExample{public static void main(String[] args) throws Exception{CuicServer server =

CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIFencedContainer instance = new UserAPIFencedContainer(server);ContainerDataObjects containerDataObject = instance.userAPIGetServiceContainerData(2);

System.out.println("Container Id = "+containerDataObject.getContainerId());System.out.println("Gateway =

"+containerDataObject.getVmRequestBundle().getGateway());}

}

Results

The details of the service container with the specific ID are returned.

Implementation

Call the userAPIGetServiceContainerData API by passing the service container ID to retrieve the servicecontainer details.


ExamplesRetrieving a Service Container

See Also

Creating a Service Container with Template






Retrieving a Service Container with CatalogObjective

Retrieve the details of a service container along with the catalog item used for creating the servicecontainer.

Context

Identify the container availability to provision a VDC or VM.

Prerequisites

The logged-in user must have permission to retrieve the service container details.

REST URL/app/api/rest?formatType=json&opName=fenced:userAPIGetServiceContainerDetails&opData={param0:2}

Components

container id—The ID of the service container for which you need to view the details.


ExamplesRetrieving a Service Container with Catalog

Codepublic class GetServiceContainerDetails{public static void main(String[] args) throws Exception{CuicAPIClient client = new CuicAPIClient("10.23.210.119", 80,

"38B101A62AF14024964D6A87C23C09DE", "http");List listObj = new ArrayList();//Paas the container idlistObj.add("4");JsonElement jsonResponse =

client.sendJSONRequest("fenced:userAPIGetServiceContainerDetails", listObj);JsonArray array = jsonResponse.getAsJsonObject().get("rows").getAsJsonArray();for (int count = 0; count < array.size(); count++){JsonElement jsonElement = array.get(count);JsonObject jsonObject = jsonElement.getAsJsonObject();System.out.println("Overview_Group: " +

jsonObject.get("Overview_Group").getAsString());System.out.println("Overview_ID: " + jsonObject.get("Overview_ID").getAsString());

System.out.println("Overview_containerName: " +jsonObject.get("Overview_containerName").getAsString());

System.out.println("Overview_VM_Counts: " +jsonObject.get("Overview_VM_Counts").getAsString());

System.out.println("Overview_ServiceRequestStatus: "+ jsonObject.get("Overview_ServiceRequestStatus").getAsString());

System.out.println("vInfraPolicyInfo_ContainerType: "+ jsonObject.get("vInfraPolicyInfo_ContainerType").getAsString());

System.out.println("Policy_VirtualCompute: " +jsonObject.get("Policy_VirtualCompute").getAsString());

System.out.println("Policy_VirtualNetwork: " +jsonObject.get("Policy_VirtualNetwork").getAsString());

System.out.println("Policy_VirtualSystem: " +jsonObject.get("Policy_VirtualSystem").getAsString());

System.out.println("Policy_VirtualStorage: " +jsonObject.get("Policy_VirtualStorage").getAsString());

}}

}

Results

The following service container details are returned:

• Overview_Group: Default Group

• Overview_ID: 4

• Overview_containerName: cont1

• Overview_VM_Counts: Container is Empty

• Overview_ServiceRequestStatus: Complete

• vInfraPolicyInfo_ContainerType: Fenced Virtual

• Policy_VirtualCompute: VNX_CLOUD69 - Default Computing Policy

• Policy_VirtualNetwork: VNX_CLOUD69 - Default Network Policy

• Policy_VirtualSystem: Default System Policy

• Policy_VirtualStorage: VNX_CLOUD69 - Default Storage Policy


ExamplesRetrieving a Service Container with Catalog

Implementation

Call the userAPIGetServiceContainerDetails API by passing the container ID to retrieve the servicecontainer details.

See Also







Listing all Service Containers in Cisco UCS DirectorObjective

Retrieve and display all the service containers that are available in Cisco UCS Director.

Context

To view the list of service containers (APIC and fenced) in Cisco UCS Director.

Prerequisites

The service containers must be available in Cisco UCS Director.

REST URL

Request/app/api/rest?formatType=json&opName=apic:userAPIGetAllServiceContainers&opData={}

Response{ "serviceResult":[{"id":2,"containerType":"APIC","containerName":"cdevBld","containerLabel":"","containerState":2,"tenantIdentity":"VNX_APIC185@cdev23","privateNetwork":null,"hostsNumberPerTier":"","groupId":4,"vdcId":2,"provisionedTime":1464001006693,"termiantionTime":-1,"srId":1107,"enableDR":false,"primaryServiceContainerId":-1,"serviceContainerRole":"PRIMARY","configureResourceLimit":true,"cpu":1.0,"ncpu":3,"memory":3.0,"provisionedDiskGBLimit":20.0,"halfWidthPhysicalServerLimit":1,"fullWidthPhysicalServerLimit":1,"enableNetworkMgmt":true,"networkThrougput":"100M","customTierLabels":null,"vmLabels":{"list":[],"moTypeName":"com.cloupia.model.serviceContainer.VMsLabelCustomizationConfig","validatorName":null},"customTierProperty":null}], "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPIGetAllServiceContainers" }

Components

None


ExamplesListing all Service Containers in Cisco UCS Director

Code



import java.util.ArrayList;import java.util.Iterator;import java.util.List;import java.util.Map;import java.util.Map.Entry;import java.util.Properties;

import com.cisco.cuic.api.client.APITabularReport;import com.cisco.cuic.api.client.ContainerVirtualMachine;import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.client.JSON;import com.cisco.cuic.api.models.UserAPIFencedContainer;import com.cisco.cuic.api.models.UserAPIGlobal;importcom.cisco.cuic.api.models.servicecontainer.APIFencedVirtualContainerTemplateConfig;import com.cisco.cuic.api.models.servicecontainer.APIFencedVirtualMachineConfig;import com.cisco.cuic.api.models.servicecontainer.APIServiceContainerTemplate;import com.cisco.cuic.api.models.servicecontainer.ContainerDataObjects;import com.cisco.cuic.api.models.servicecontainer.DFAConfig;import com.cisco.cuic.api.models.servicecontainer.FencedContainerOptions;import com.cisco.cuic.api.models.servicecontainer.FencedContainerPolicies;import com.cisco.cuic.api.models.servicecontainer.FencedContainerWorkflowConfig;import com.cisco.cuic.api.models.servicecontainer.FencedNetwork;import com.cisco.cuic.api.models.servicecontainer.FencedVirtualMachineNetworkConfig;import com.cisco.cuic.api.models.servicecontainer.NetworkConfigProvisionedPortGroup;import com.cisco.cuic.api.models.servicecontainer.NetworkConfigRequest;import com.cisco.cuic.api.models.servicecontainer.NetworkConfigResult;import com.cisco.cuic.api.models.servicecontainer.NetworkTopology;import com.cisco.cuic.api.models.servicecontainer.OutboundACL;import com.cisco.cuic.api.models.servicecontainer.OwnerInfo;import com.cisco.cuic.api.models.servicecontainer.PortMapping;import com.cisco.cuic.api.models.servicecontainer.ServiceContainer;import com.cisco.cuic.api.models.servicecontainer.ServiceContainervInfraPolciyDef;import com.cisco.cuic.api.models.servicecontainer.ServiceContainervInfraPolicy;import com.cisco.cuic.api.models.servicecontainer.VirtualSwitch;import com.cloupia.sdk.api.CloupiaClient;import com.google.gson.JsonObject;import com.google.gson.JsonParser;

public class TestApplicationContainer{private static final String REST_SERVER_PROPERTIES = "rest-server.properties";private static final String UCSM_CONTEXT_NAME = "ucsm";private Properties props;private CloupiaClient client;private Map<String, String> reportLabelIdMap;private JsonObject obj;private JsonParser parser;

public TestApplicationContainer(){

}

public static void main(String[] args) throws Exception {TestApplicationContainer obj = new TestApplicationContainer();CuicServer server = CuicServer.getAPI("172.22.234.243", "

CF87FA987C8F4BBF814F2BB68CA6A823", "https", 443);UserAPIFencedContainer fencedC = new UserAPIFencedContainer(server);executeGetServiceContainerDetails(fencedC);}public static void executeGetServiceContainerDetails(UserAPIFencedContainer fencedC)throws Exception{APITabularReport atr = new APITabularReport();atr = fencedC.userAPIGetServiceContainerDetails(1);

List<Map<String, Object>> listofMaps = atr.getRows();// System.out.println("rows " + atr.getRowCount());for (Map<String, Object> map : listofMaps) {for (Entry<String, Object> entry : map.entrySet()) {// System.out.println(entry.getKey() + ":");String o = entry.toString();



System.out.println(o);}}}

Results

The code returns a list of service containers in Cisco UCS Director.

Implementation


See Also







Adding a Tier to a Container VMObjective

Add a tier to a VM in an APIC container.

Context

To add a tier to an APIC container VM.

Prerequisites

• The APIC container must be available in Cisco UCS Director.

• The VM must be available in the APIC container.

REST URL

Request/app/api/rest?formatType=json&opName=apic:userAPIAddTierToContainerVM&opData={param0:{"containerId":2,"tierName":"app","tierLabel":"app","isIsolated":false,"parentTierName":""}}

Response{ "serviceResult":2197, "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPIAddTierToContainerVM" }


ExamplesAdding a Tier to a Container VM

Components

The parameters of the userAPIAddTierToContainerVM API are:

• int containerId—The ID of the APIC container.

• String tierName—The name of the tier that you want to add to the APIC container.

• String tierLabel—The label of the tier.

• boolean isIsolated—Set to true to associate the tier with the parent tier in the APIC container.

• String parentTierName—The parent tier name to which the tier needs to be associated with.Provide the parent tier name when the isIsolated parameter is set to true.

Codeimport com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.apic.APIAPICAddTierToContainerParams;import com.cisco.cuic.api.models.apic.APIAPICAddvNICToContainerVMParams;import com.cisco.cuic.api.models.apic.userAPIContainerandContract;

public class userAPIAddTierToContainerVMTest{public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.22.234.243",

"CF87FA987C8F4BBF814F2BB68CA6A823", "http", 80);userAPIContainerandContract instance = new userAPIContainerandContract(api);APIAPICAddTierToContainerParams param=new APIAPICAddTierToContainerParams();param.setContainerId(2);param.setIsolated(false);param.setParentTierName("");param.setTierLabel("apps");param.setTierName("apps");int requestId=instance.userAPIAddTierToContainerVM(param);System.out.println(requestId);}}

Results

Returns a service request ID on successful addition of tier to the APIC container VM.

Implementation

Use the userAPIAddTierToContainerVM API to add a tier to the APIC container VM.

See Also








ExamplesAdding a Tier to a Container VM

Adding a Virtual Network Interface Card to a Container VMObjective

Add a virtual Network Interface Card (vNIC) to a VM in an APIC container.

Context

To add a vNIC to an APIC container VM.

Prerequisites

• The APIC container must be available in Cisco UCS Director.

• The VM must be available in the APIC container.

REST URL

Request/app/api/rest?formatType=json&opName=apic:userAPIAddvNICToContainerVM&opData={param0:{"containerId":"2","vmId":"1","vmUsername":"root","vmPassword":"cloupia123","networkName":"Con"}}

Response{ "serviceResult":2190, "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPIAddvNICToContainerVM" }

Components

The parameters of the userAPIAddvNICToContainerVM API are:

• int containerId—The ID of the APIC container.

• int vmId—The ID of the VM to which you need to add vNIC.

• String vmUsername—The username that is used to access the VM.

• String vmPassword—The password that is used to access the VM.

• String networkName—The tier or network within the same application container where the VMresides in.


ExamplesAdding a Virtual Network Interface Card to a Container VM

Codeimport com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.UserAPIVMware;import com.cisco.cuic.api.models.apic.APIAPICAddvNICToContainerVMParams;import com.cisco.cuic.api.models.apic.userAPIContainerandContract;

public class userAPIAddvNICToContainerVMTest{public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.22.234.243",

"CF87FA987C8F4BBF814F2BB68CA6A823", "http", 80);userAPIContainerandContract instance = new userAPIContainerandContract(api);APIAPICAddvNICToContainerVMParams param=new APIAPICAddvNICToContainerVMParams();param.setContainerId("2");param.setNetworkName("Con");param.setVmId("1");param.setVmUsername("root");param.setVmPassword("cloupia123");int requestId=instance.userAPIAddvNICToContainerVM(param);System.out.println(requestId);}}

Results

Returns a service request ID on successful addition of vNIC to the APIC container VM.

Implementation

Use the userAPIAddvNICToContainerVM API to add a vNIC to an APIC container VM.

See Also







Deleting a Service ContainerObjective

Delete a service container from Cisco UCS Director.

Context

Reuse the resources that are occupied by the provisioned VM in a container. After the usage of VM,the VM provisioning is rolled back. Then, the container must be deleted to release the resources allocatedfor the VM.


ExamplesDeleting a Service Container

Prerequisites

• The logged-in user must have permission to delete a service container.

• The container must not have any VMs.

REST URL/app/api/rest?formatType=json&opName=fenced:userAPIDeleteServiceContainer&opData={param0:3}

Components

containerId—The ID of the service container to be deleted.

Codepublic class DeleteServiceContainerDataExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64","https",443);UserAPIFencedContainer instance = new UserAPIFencedContainer(server);int srId = instance.userAPIDeleteServiceContainer(2);System.out.println(“Delete SR id "+srId);}}

Results

The service container is deleted and a service request ID is returned.

Implementation

Delete a service container by passing the service container ID.

See Also








ExamplesDeleting a Service Container

Managing Contracts

Creating a ContractObjective

Create a contract between two networks in an APIC container.

Context

To create a contract between two networks.

Prerequisites

APIC container must be present in Cisco UCS Director.

REST URL

Request/app/api/rest?formatType=json&opName=apic:userAPICreateContract&opData={param0:{"containerId":2,"ruleName":"rule1","ruleDescription":"sample","sourceNetwork":"web","destNetwork":"app","createRule":true,"protocol":"TCP","applyBothDirections":true,"sourcePortStart":"10","sourcePortend":"20","destinationPortStart":"30","destinationPortEnd":"40","fireallAction":1000,"enableStatefull":true}}

Response{ "serviceResult":2166, "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPICreateContract" }


ExamplesManaging Contracts

Components

The parameters of the userAPICreateContract API are:

• int containerId—The unique ID of the APIC container for which the contract is created.

• String ruleName—The name of the rule. This rule is used internally by Cisco UCS Director forits own reference.

• String ruleDescription—The description of the rule. The rule filter name is created on APIC andis autogenerated using the container name.

• String sourceNetwork—The source network to which you want to apply the contract rule.

• String destNetwork—The destination network to which you want to apply the contract rule.

• boolean createRule—Set to true to create a rule.

• String protocol—The protocol for communication.

• boolean applyBothDirections—Set to true to apply the same contract for traffic from source todestination.

• int sourcePortStart—The starting port number of the specified port range of source.

• int sourcePortend—The ending port number of the specified port range of source.

• int destinationPortStart—The starting port number of the specified port range of destination.

• int destinationPortEnd—The ending port number of the specified port range of destination.

• int fireallAction—Leave this parameter empty.

• boolean enableStatefull—Set to true to enable stateful.


ExamplesCreating a Contract

Codeimport com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.apic.APIAPICAddTierToContainerParams;import com.cisco.cuic.api.models.apic.APICCreateContractParams;import com.cisco.cuic.api.models.apic.userAPIContainerandContract;

public class userAPICreateContractTest{public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.22.234.243",

"CF87FA987C8F4BBF814F2BB68CA6A823", "http", 80);userAPIContainerandContract instance = new userAPIContainerandContract(api);APICCreateContractParams param=new APICCreateContractParams();param.setContainerId(2);param.setApplyBothDirections(true);param.setCreateRule(true);param.setDestinationPortEnd("40");param.setDestinationPortStart("30");param.setDestNetwork("app");param.setSourceNetwork("web");param.setEnableStatefull(true);param.setFireallAction(100);param.setProtocol("TCP");param.setRuleDescription("sdk");param.setRuleName("Rule123");param.setSourcePortend("20");param.setSourcePortStart("10");int requestId=instance.userAPICreateContract(param);System.out.println(requestId);}}

Results

A unique contract ID is returned after successful creation of a contract in the Cisco UCSDirector server.

Implementation

Use the userAPICreateContract API and pass the necessary data to create a contract.

See Also

Deleting a Contract

Deleting a ContractObjective

Delete a contract between networks in an APIC container.

Context

The catalog can be deleted by a system administrator.

Prerequisites

APIC container must be present in Cisco UCS Director.


ExamplesDeleting a Contract

REST URL

Request/app/api/rest?formatType=json&opName=apic:userAPIDeleteContract&opData={param0:{"ruleId":"rule1","srcNetwork":"web","destNetwork":"app"}}

Response{"serviceResult":2176, "serviceError":null, "serviceName":"InfraMgr","opName":"apic:userAPIDeleteContract" }

Components

The parameters of the userAPIDeleteContract API are:

• String ruleName—The name of the rule that you want to delete.

• String srcNetwork—The source network from which you want to delete the contract rule.

• String destNetwork—The destination network from which you want to delete the contract rule.

Codeimport com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.apic.APICCreateContractParams;import com.cisco.cuic.api.models.apic.APICDeleteContractParams;import com.cisco.cuic.api.models.apic.userAPIContainerandContract;

public class userAPIDeleteContractTest{public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.22.234.243",

"CF87FA987C8F4BBF814F2BB68CA6A823", "http", 80);userAPIContainerandContract instance = new userAPIContainerandContract(api);APICDeleteContractParams param=new APICDeleteContractParams();param.setDestNetwork("app");param.setRuleId("Rule123");param.setSrcNetwork("web");int requestId=instance.userAPIDeleteContract(param);System.out.println(requestId);}}

Results

Returns the service request ID on successful deletion of the contract between the source and destinationnetworks.

Implementation

Call the userAPIDeleteContract API and pass the rule name, source network, and destination networkto delete the contract between the source and destination networks.

See Also

Creating a Contract


ExamplesDeleting a Contract

Managing Virtual Machines

Powering On a VMObjective

Power on a VM.

Context

Manage the VMs that are available on VDC.

Prerequisites

VM must be available for access.

REST URL/app/api/rest?formatType=json&opName=userAPIExecuteVMAction&opData={param0:5,param1:"powerOn",param2:"Power On sample test"}

Components

• int vmId—The ID of the virtual machine that need to be powered on.

• String actionName—Set the value as powerOn.

• String comments—Optional. Additional information, if any.

Codepublic class userAPIExecuteVMActionExample{public static void main(String[] args) throws Exception{

CuicServer server = CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);

UserAPIGlobal instance = new UserAPIGlobal(server);String statusMsg = instance.userAPIExecuteVMAction(1,"powerOn","Testing");System.out.println(" Response msg is "+statusMsg);

}}

Results

Provide a status for the powered on VM.

Implementation

Pass the VM ID and set the action name as power on in the userAPIExecuteVMAction API to poweron the VM.


ExamplesManaging Virtual Machines

See Also

Rebooting a VM

Adding a Virtual Network Interface Card to a VM, on page 61

Powering Off a VM

Rebooting a VMObjective

Reboot a VM.

Context

Manage the VMs available on VDC.

Prerequisites


REST URL/app/api/rest?formatType=json&opName=userAPIExecuteVMAction&opData={param0:5,param1:"reboot",param2:"Reboot VM"}

Components

• int vmId—The ID of the virtual machine that need to be reboot.

• String actionName—Set the value as reboot.


Codepublic class userAPIExecuteVMActionExample {public static void main(String[] args) throws Exception {CuicServer server = CuicServer.getAPI("192.0.2.207", "1A8DE698E2BF4C0B989476A369F0FC64","https", 443);

UserAPIGlobal instance = new UserAPIGlobal(server);String statusMsg = instance.userAPIExecuteVMAction(1, "Reboot", "Testing");System.out.println(" Response msg is "+statusMsg);}}

Results

Provides a status of the reboot VM.

Implementation

Pass the VM ID and set the action name as reboot in the userAPIExecuteVMAction API to reboot theVM.


ExamplesRebooting a VM

See Also

Powering On a VM


Powering Off a VM

Adding a Virtual Network Interface Card to a VMObjective

Add a virtual Network Interface Card (vNIC) to a VM to bridge a network. The vNICmust be availablefor both APIC and Fenced containers, and for standard catalog VMs.

Context

Virtualization of a network.

Prerequisites

Ensure that the portGroupIdentity, static IP pool, valid container template (APIC or fenced), and standardcatalog VM are available.

REST URL

Request with DHCP set to Trueapp/api/rest?formatType=json&opName=genericvm:userAPIAddVMNICs&opData={param0:{"vmId":531,"vNICConfig":[{"portGroupIdentity":"[email protected]@vSwitch0@VM Network@VirtualMachine Portgroup","isDHCP":false,"staticIpPool":"10.10.20.8","subnetMask":"255.255.255.0","gateway":"10.10.20.1"}]}}

Request with DHCP set to False/app/api/rest?formatType=json&opName=genericvm:userAPIAddVMNICs&opData={param0:{"vmId":49,"vNICConfig":[{"portGroupIdentity":"[email protected]@vSwitch0@VM Network@VirtualMachine Portgroup","isDHCP":false,"staticIpPool":"","subnetMask":"","gateway":""}]}}


ExamplesAdding a Virtual Network Interface Card to a VM

Components

• vmId—ID of the VM to which you need to add vNIC.

• vNICConfig—The vNIC configuration to be added to VM. Need to set the following VMconfiguration:

◦portGroupIdentity—ID of the portgroup to be assigned to vNIC. The allowed format of theport group identity is<cloudName>@<hostName>@<switchName>@<portGroupName>@<portGroupType>.

◦isDHCP—Set to True to enable the DHCP configuration.

◦staticIpPool—This field is optional when the isDHCP parameter is set to True. The IP addressfor the static IP configuration.

◦subnetMask—This field is optional when the isDHCP parameter is set to true. The subnetmask address for the static IP configuration.

◦gateway—This field is optional when the isDHCP parameter is set to true. The gatewayaddress for the static IP configuration.

Codepublic static void main(String[] args) throws Exception{CuicServer api = CuicServer.getAPI("172.31.234.172","E052D5B0D1BD4B3199DEB36620AA0004", "http", 80);UserAPIVMware instance = new UserAPIVMware(api);

List<VMNICsInputConfig> vNICConfig = new ArrayList<VMNICsInputConfig>();VMNICsInputConfig nicConfig = new VMNICsInputConfig();

nicConfig.setPortGroupIdentity("[email protected]@vSwitch0@ctr-sdk-pg-lan0@VirtualMachine Portgroup");nicConfig.setDHCP(true);nicConfig.setStaticIpPool(null);nicConfig.setSubnetMask(null);nicConfig.setGateway(null);

vNICConfig.add(nicConfig);

APIVMNICInputParams param = new APIVMNICInputParams();param.setVmId(38);param.setvNICConfig(vNICConfig);APIVMNICOutputDetails output = instance.userAPIAddVMNICs(param);System.out.println("VM Id: "+output.getVmId());for(VMNICOutputDetails details : output.getvNicDetails()){System.out.println("Adaptor Name: "+details.getAdapterName());System.out.println("MAC Address: "+details.getMacAddress());System.out.println("Static IP: "+details.getStaticIpPool());System.out.println("Subnet Mask: "+details.getSubnetMask());System.out.println("Gateway: "+details.getGateway());}

}


ExamplesAdding a Virtual Network Interface Card to a VM

Results

vNIC is added to the VM.

Sample Result

• VM Id: 38

• Adaptor Name: eth1

• MAC Address: 00:50:56:81:76:ba

• Static IP: null

• Subnet Mask: null

• Gateway: null

REST URL Response{ "serviceResult":{"vmId":49,"vNicDetails":[{"adapterName":"eth1","macAddress":"00:50:56:8b:73:8b","staticIpPool":"10.10.10.0","subnetMask":"255.255.255.0","gateway":"10.10.10.1"}]}, "serviceError":null,"serviceName":"InfraMgr", "opName":"genericvm:userAPIAddVMNICs" }

Implementation

• For the DHCP configuration, set the isDHCP parameter as true. Once the DHCP is configured,the IP address is assigned dynamically.

• For the static configuration, set the isDHCP parameter as false and provide values for thestaticIPPool, subnetMask, and gateway parameters.

• If the selected VM is associated to a container, the isDHCP parameter is set to false, and the valuesfor staticIPPool, subnetMask, and gateway are not provided, the system checks for the containertemplate network configuration to get the static IP configuration.

See Also

Powering On a VM, on page 59

Rebooting a VM, on page 60

Powering Off a VM, on page 63

Powering Off a VMObjective

Power off a VM.

Context

Manage the VMs available on VDC.


ExamplesPowering Off a VM

Prerequisites


REST URL/app/api/rest?formatType=json&opName=userAPIExecuteVMAction&opData={param0:5,param1:"powerOff",param2:"Power off sample test"}

Components

• int vmId—The ID of the virtual machine that need to be powered off.

• String actionName—Set the value as powerOff.


Codepublic class userAPIExecuteVMActionExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);String statusMsg = instance.userAPIExecuteVMAction(1,"powerOff","Testing");System.out.println(" Response msg is "+statusMsg);}}

Results

Provide a status for the powered off VM.

Implementation

Pass the VM ID and set the action name as power off in the userAPIExecuteVMAction API to poweroff the VM.

See Also

Powering On a VM

Rebooting a VM


Setting up a VMware VM Guest and Executing VIX ScriptObjective

Set up a VMware VM guest to perform certain operations (such as, power on a VM, power off a VM,and rename a VM) on the target VM.


ExamplesSetting up a VMware VM Guest and Executing VIX Script

Context

Execute VIX script on the target VM.

Prerequisites

VMware tools need installed on the VM.

REST URL/app/api/rest?formatType=json&opName=genericvm:userAPIExecuteVIXScript&opData={param0:355,param1:"root",param2:"cloupia123",param3:"/bin/echo \"Hello\";/bin/echo 'NPROXY=\$1'"}

Components

VM ID, credentials, and VIX script are required.

Codepublic class VIXScriptExecuteUsingGuestSetup{public static void main(String[] args){CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);GuestSetup instance = new GuestSetup(server);instance.setVmId(120);instance.setCredentialsOptions("Do not Share");instance.setUserId("admin");instance.setPassword("admin");GuestSetupResponse obj = instance.execute();

System.out.println("userid " + instance.getUserId());System.out.println("vm id " + instance.getVmId());System.out.println("password " + instance.getPassword());

ExecuteVIXScript instancevix = new ExecuteVIXScript(server);instancevix.setAccountName("cloud123");instancevix.setVmId(instance.getVmId());instancevix.setCredentialType("Login");instancevix.setLogin(instance.getUserId());instancevix.setPassword(instance.getPassword());instancevix.setScript("/bin/date");instancevix.setUndoScript("");instancevix.setUndoScriptTask(false);instancevix.setOutputDisplay(false);ExecuteVIXScriptResponse response = instancevix.execute();System.out.println("Respose status Code "+response.getResponseErrorCode());}}

Result

The response code is returned for the executed VIX script.

Implementation

Use the userAPIExecuteVIXScript API and pass the VM ID, credentials, and VIX script to execute theVIX script on the VM.


ExamplesSetting up a VMware VM Guest and Executing VIX Script

Managing VMware System Policy

Creating a VMware System PolicyObjective

Create a VMware system policy to define the system specific information such as the template to use,time zone, OS specific information, and so on for a virtual machine (VM).

Context

To define system specific information for a VM.

Prerequisites

None


ExamplesManaging VMware System Policy

REST URL

This section provides the REST URL for creating VMware system policy in different scenarios:

Example 1: Create a VMware system policy with the Linux image

Request/app/api/rest?formatType=json&opName=genericvm:userAPICreateVMwareSystemPolicy&opData={param0:{"policyName":"test","policyDescription":"sample","vmImageType":"Linux Only","vmNameTemplate":"sample","vmnamevalidationPolicy":"sample","hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxVM":{"dnsDomain":"sample","dnsSuffix":"sample","dnsServer":"sample","linuxTimeZone":"US/Arizona","maxBootWaitTime":10},"windowsVM":"productId":"sample","licenseOwnerName":"sample","organizationName":"sample","licenseMode":"sample","noOfLicenseUsers":1000,"primaryWINs":"sample","secondaryWINS":"sample","maxBootTime":1000,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"administratorPassword":"sample","windowsTimezone":"sample","joinTypeDomain":"sample","workGroupName":"sample","domain":"sample","domainAdmin":"sample","domainPassword":"sample","defineAnnotation":true}}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"genericvm:userAPICreateVMwareSystemPolicy" }

Example 2: Create a VMware system policy with the Windows and Linux image

Request/app/api/rest?formatType=json&opName=genericvm:userAPICreateVMwareSystemPolicy&opData={param0:{"policyName":"test1","policyDescription":"sample","vmImageType":"Windows and Linux","vmNameTemplate":"sample","vmnamevalidationPolicy":"sample","hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxVM":{"dnsDomain":"sample","dnsSuffix":"sample","dnsServer":"sample","linuxTimeZone":"US/Arizona","maxBootWaitTime":10},"windowsVM":{"productId":"sample","licenseOwnerName":"sample","organizationName":"sample","licenseMode":"Per-Seat","noOfLicenseUsers":1000,"primaryWINs":"sample","secondaryWINS":"sample","maxBootTime":10,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"administratorPassword":"sample","windowsTimezone":"Alaskan Time","joinTypeDomain":"Domain","workGroupName":"sample","domain":"sample","domainAdmin":"sample","domainPassword":"sample","defineAnnotation":true}}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"genericvm:userAPICreateVMwareSystemPolicy" }

Components

None


ExamplesCreating a VMware System Policy

Codepublic class CreateSystemPolicyTest{public static void main(String[] args)throws Exception{CuicServer api = CuicServer.getAPI("172.29.110.194","6BF80FA2C71E4844AFEB3877CFD60621", "http", 80);UserAPIVMware instance = new UserAPIVMware(api);ServiceDeliveryPolicyRequestParam service = new ServiceDeliveryPolicyRequestParam();

LinuxVMParams linux=new LinuxVMParams();linux.setDnsDomain("testdomain");linux.setLinuxTimeZone("US/Pacific");linux.setLinuxVMmaxBootWaitTime(2);WindowsVMParams window=new WindowsVMParams();window.setOrganizationName("testOrganization");service.setPolicyName("test2");service.setPolicyDescription("test");service.setVmImageType("Linux Only");service.setHostNameTemplate("sample1");service.setLinuxVM(linux);service.setWindowsVM(window);boolean policy= instance.userAPICreateVMwareSystemPolicy(service);System.out.println(policy);}

Results

If the VMware system policy is created successfully, the result is true.

Implementation

Use the userAPICreateVMwareSystemPolicyAPI and pass the system specific information in the nameand value format to create a VMware system policy.

See Also

Retrieving the VMware System Policy Details

Modifying a VMware System Policy

Deleting a VMware System Policy

Retrieving the VMware System Policy DetailsObjective

Retrieve the VMware system policy details.

Context

The VMware system policy details are retrieved by the system administrator or the end user.

Prerequisites

None


ExamplesRetrieving the VMware System Policy Details

REST URL

This section provides the REST URL for retrieving VMware system policy in different scenarios:

Example 1: Retrieve details of a specific VMware system policy

Request/app/api/rest?formatType=json&opName=genericvm:userAPIGetVMwareSystemPolicy&opData=param0:{"policyName":"test","policyDescription":"sample","vmImageType":"sample","vmNameTemplate":"sample","vmnamevalidationPolicy":"sample","hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxVM":{"dnsDomain":"sample","dnsSuffix":"sample","dnsServer":"sample","linuxTimeZone":"sample","maxBootWaitTime":0},"windowsVM":{"productId":"sample","licenseOwnerName":"sample","organizationName":"sample","licenseMode":"sample","noOfLicenseUsers":1000,"primaryWINs":"sample","secondaryWINS":"sample","maxBootTime":1000,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"administratorPassword":"sample","windowsTimezone":"sample","joinTypeDomain":"sample","workGroupName":"sample","domain":"sample","domainAdmin":"sample","domainPassword":"sample","defineAnnotation":true}}}

Response{ "serviceResult":{"policyId":8,"policyName":"test","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxTimezone":"US/Arizona","linuxVMMaxBootTime":4,"dnsDomain":"sample","dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":1,"windowsLabel":null,"productId":null,"fullName":"CompanyFullName","orgName":"CompanyName","licenseMode":"Per-Seat","licenseUsers":5,"winList":null,"secondaryWINS":null,"windowsVMMaxBootTime":10,"isSIDUnique":false,"isAutoLogon":true,"autoLogonCount":5,"password":null,"windowsTimezone":4,"joinTypeDomain":true,"workGroupName":null,"domain":null,"domainAdmin":null,"domainPassword":null,"defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false}, "serviceError":null,"serviceName":"InfraMgr", "opName":"genericvm:userAPIGetVMwareSystemPolicy" }

Example 2: Retrieve details of all the VMware system policies

Request/app/api/rest?formatType=json&opName=genericvm:userAPIGetAllVmwareSystemPolicies&opData={}



Response{ "serviceResult":[{"policyId":1,"policyName":"Default System Policy","policyDescription":"","vmNameTemplate":"vm-${GROUP_NAME}-SR${SR_ID}","vmNameValidationPolicy":"","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"${VMNAME}","hostNameValidationPolicy":"","linuxTimezone":"US/Pacific","linuxVMMaxBootTime":10,"dnsDomain":"sdk","dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":"","imageType":1,"windowsLabel":null,"productId":"","fullName":"CompanyFullName","orgName":"CompanyName","licenseMode":"Per-Seat","licenseUsers":5,"winList":"","secondaryWINS":"","windowsVMMaxBootTime":10,"isSIDUnique":false,"isAutoLogon":true,"autoLogonCount":5,"password":"","windowsTimezone":4,"joinTypeDomain":true,"workGroupName":"","domain":"","domainAdmin":"","domainPassword":"","defineAnnotation":false,"notes":null,"customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false},{"policyId":2,"policyName":"sample","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"host","hostNameValidationPolicy":"sample","linuxTimezone":"US/Arizona","linuxVMMaxBootTime":4,"dnsDomain":"sample","dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":1,"windowsLabel":null,"productId":null,"fullName":"CompanyFullName","orgName":"CompanyName","licenseMode":"Per-Seat","licenseUsers":5,"winList":null,"secondaryWINS":null,"windowsVMMaxBootTime":10,"isSIDUnique":false,"isAutoLogon":true,"autoLogonCount":5,"password":null,"windowsTimezone":4,"joinTypeDomain":true,"workGroupName":null,"domain":null,"domainAdmin":null,"domainPassword":null,"defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false},{"policyId":3,"policyName":"sample1","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxTimezone":"US/Pacific","linuxVMMaxBootTime":10,"dnsDomain":null,"dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":0,"windowsLabel":null,"productId":"sample","fullName":"sample","orgName":"","licenseMode":"Per-Server","licenseUsers":1000,"winList":"sample","secondaryWINS":"sample","windowsVMMaxBootTime":10,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"password":"c2FtcGxl","windowsTimezone":2,"joinTypeDomain":true,"workGroupName":null,"domain":"admin","domainAdmin":"admin","domainPassword":"YWRtaW4=","defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false},{"policyId":6,"policyName":"sample5","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxTimezone":"US/Arizona","linuxVMMaxBootTime":6,"dnsDomain":"sample","dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":1,"windowsLabel":null,"productId":null,"fullName":"CompanyFullName","orgName":"CompanyName","licenseMode":"Per-Seat","licenseUsers":5,"winList":null,"secondaryWINS":null,"windowsVMMaxBootTime":10,"isSIDUnique":false,"isAutoLogon":true,"autoLogonCount":5,"password":null,"windowsTimezone":4,"joinTypeDomain":true,"workGroupName":null,"domain":null,"domainAdmin":null,"domainPassword":null,"defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false},{"policyId":7,"policyName":"sample6","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxTimezone":"US/Pacific","linuxVMMaxBootTime":10,"dnsDomain":null,"dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":0,"windowsLabel":null,"productId":"sample","fullName":"sample","orgName":"sample","licenseMode":"Per-Seat","licenseUsers":1000,"winList":"sample","secondaryWINS":"sample","windowsVMMaxBootTime":10,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"password":"c2FtcGxl","windowsTimezone":1,"joinTypeDomain":true,"workGroupName":null,"domain":"sam","domainAdmin":"sample","domainPassword":"c2FtcGxl","defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false},{"policyId":8,"policyName":"test","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxTimezone":"US/Arizona","linuxVMMaxBootTime":4,"dnsDomain":"sample","dnsSuffix":null,



"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":1,"windowsLabel":null,"productId":null,"fullName":"CompanyFullName","orgName":"CompanyName","licenseMode":"Per-Seat","licenseUsers":5,"winList":null,"secondaryWINS":null,"windowsVMMaxBootTime":10,"isSIDUnique":false,"isAutoLogon":true,"autoLogonCount":5,"password":null,"windowsTimezone":4,"joinTypeDomain":true,"workGroupName":null,"domain":null,"domainAdmin":null,"domainPassword":null,"defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false},{"policyId":9,"policyName":"test1","policyDescription":"sample","vmNameTemplate":"sample","vmNameValidationPolicy":"sample","isAllowEndUserSuffix":false,"powerOn":true,"hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxTimezone":"US/Pacific","linuxVMMaxBootTime":10,"dnsDomain":null,"dnsSuffix":null,"dnsSuffixList":null,"dnsServer":null,"dnsServerList":null,"resourcePool":null,"imageType":0,"windowsLabel":null,"productId":"sample","fullName":"sample","orgName":"sample","licenseMode":"Per-Seat","licenseUsers":1000,"winList":"sample","secondaryWINS":"sample","windowsVMMaxBootTime":10,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"password":"c2FtcGxl","windowsTimezone":3,"joinTypeDomain":true,"workGroupName":null,"domain":"sample","domainAdmin":"sample","domainPassword":"c2FtcGxl","defineAnnotation":false,"notes":"","customAttributes":{"list":[],"moTypeName":"com.cloupia.service.cIM.inframgr.profiles.PrivateCloudSystemPolicyAnnotation","validatorName":null},"customAttributesList":[],"vmAnnotationsClob":null,"isUseLicenseFromTemplate":false,"skipCustomization":false}], "serviceError":null,"serviceName":"InfraMgr", "opName":"genericvm:userAPIGetAllVmwareSystemPolicies" }

Components

None

Codepublic class GetSystemPolicyTest{public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.29.110.194","6BF80FA2C71E4844AFEB3877CFD60621", "http", 80);UserAPIVMware instance = new UserAPIVMware(api);ServiceDeliveryPolicyRequestParam service = new ServiceDeliveryPolicyRequestParam();

service.setPolicyName("test2");PrivateCloudSystemProfile policy= instance.userAPIGetVMwareSystemPolicy(service);System.out.println("policyName:" + policy.getPolicyName());System.out.println("policyDescription:" +policy.getPolicyDescription());System.out.println("ImageType:" + policy.getImageType());System.out.println("maxBootTime :" + policy.getLinuxVMMaxBootTime());}

Results

If the valid system policy name is given, the VMware system policy details are retrieved successfully.

The following VMware system policy details are retrieved when calling theuserAPIGetVMwareSystemPolicy API:

• policyName:test

• policyDescription: sample

• imageType:Linux Only

• maxBootTime: 10



Implementation

Call the userAPIGetVMwareSystemPolicy API by passing the VMware system policy name to retrievethe VMware system policy details. Call the userAPIGetAllVmwareSystemPolicies API to view detailsof all the VMware system policies.

See Also

Creating a VMware System Policy



Modifying a VMware System PolicyObjective

Update the VMware system policy.

Context

To update the system specific information defined for a VM.

Prerequisites

None

REST URL

Request/app/api/rest?formatType=json&opName=genericvm:userAPIUpdateVMwareSystemPolicy&opData={param0:{"policyName":"test","policyDescription":"sample","vmImageType":"Linux Only","vmNameTemplate":"sample","vmnamevalidationPolicy":"sample","hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxVM":{"dnsDomain":"sample","dnsSuffix":"sample","dnsServer":"sample","linuxTimeZone":"US/Arizona","maxBootWaitTime":4},"windowsVM":{"productId":"sample","licenseOwnerName":"sample","organizationName":"sample","licenseMode":"sample","noOfLicenseUsers":1000,"primaryWINs":"sample","secondaryWINS":"sample","maxBootTime":1000,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"administratorPassword":"sample","windowsTimezone":"sample","joinTypeDomain":"sample","workGroupName":"sample","domain":"sample","domainAdmin":"sample","domainPassword":"sample","defineAnnotation":true}}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"genericvm:userAPIUpdateVMwareSystemPolicy" }

Components

None


ExamplesModifying a VMware System Policy

Codepublic static void main(String[] args)throws Exception{CuicServer api = CuicServer.getAPI("172.29.110.194",

"6BF80FA2C71E4844AFEB3877CFD60621", "http", 80);UserAPIVMware instance = new UserAPIVMware(api);ServiceDeliveryPolicyRequestParam service = new ServiceDeliveryPolicyRequestParam();

service.setPolicyName("test2");service.setVmImageType("Linux Only");service.setHostNameTemplate("sample2");LinuxVMParams linux=new LinuxVMParams();linux.setDnsDomain("testdomain");linux.setLinuxTimeZone("US/Pacific");linux.setLinuxVMmaxBootWaitTime(2);WindowsVMParams window=new WindowsVMParams();window.setOrganizationName("testOrganization");service.setLinuxVM(linux);service.setWindowsVM(window);boolean policy= instance.userAPIUpdateVMwareSystemPolicy(service);System.out.println(policy);}

Results

If the VMware system policy is updated successfully, the result is true.

Implementation

Use the userAPIUpdateVMwareSystemPolicy API and pass the system specific information that needto be updated in the name and value format to update the VMware system policy.

See Also




Deleting a VMware System PolicyObjective

Delete a VMware system policy by passing the policy name.

Context

The VMware system policy can be deleted by a system administrator.

Prerequisites

The VMware system policy to be deleted must exist.


ExamplesDeleting a VMware System Policy

REST URL

Request/app/api/rest?formatType=json&opName=genericvm:userAPIDeleteVMwareSystemPolicy&opData={param0:{"policyName":"test","policyDescription":"sample","vmImageType":"sample","vmNameTemplate":"sample","vmnamevalidationPolicy":"sample","hostNameTemplate":"sample","hostNameValidationPolicy":"sample","linuxVM":{"dnsDomain":"sample","dnsSuffix":"sample","dnsServer":"sample","linuxTimeZone":"sample","maxBootWaitTime":0},"windowsVM":{"productId":"sample","licenseOwnerName":"sample","organizationName":"sample","licenseMode":"sample","noOfLicenseUsers":1000,"primaryWINs":"sample","secondaryWINS":"sample","maxBootTime":1000,"isSIDUnique":true,"isAutoLogon":true,"autoLogonCount":1000,"administratorPassword":"sample","windowsTimezone":"sample","joinTypeDomain":"sample","workGroupName":"sample","domain":"sample","domainAdmin":"sample","domainPassword":"sample","defineAnnotation":true}}}

Response{ "serviceResult":true, "serviceError":null, "serviceName":"InfraMgr","opName":"genericvm:userAPIDeleteVMwareSystemPolicy" }

Components

None

Codepublic class DeleteSystemPolicyTest{public static void main(String[] args) throws Exception]{CuicServer api = CuicServer.getAPI("172.29.110.194","6BF80FA2C71E4844AFEB3877CFD60621", "http", 80);UserAPIVMware instance = new UserAPIVMware(api);ServiceDeliveryPolicyRequestParam service = new ServiceDeliveryPolicyRequestParam();

service.setPolicyName("test23423");boolean policy= instance.userAPIDeleteVMwareSystemPolicy(service);system.out.println(policy);}

Results

If the VMware system policy is deleted successfully, the result is true.

Implementation

Call the userAPIDeleteVMwareSystemPolicy API by passing the policy name to delete an existingVMware system policy.

See Also





ExamplesDeleting a VMware System Policy

Deleting a VMware SnapshotObjective

Delete a VMware snapshot.

Context

Provide more disk space for newer snapshots. The VMware snapshot can be deleted only by theadministrator.

Prerequisites

VMware snapshot must be available.

REST URL

Not Applicable

Components

Snapshot name is required.

Codepublic class DeleteVMSnapshotExample{public static void main(String[] args){CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);DeleteVMSnapshot instance = new DeleteVMSnapshot(server);instance.setVmId(168);instance.setSnapshotName("snapshot-2015-01-10");instance.setDeleteChild(false);DeleteVMSnapshotResponse response = instance.execute();System.out.println(" Deleted response "+response.getStatus());}

}

Results

If the VM snapshot is deleted successfully, the result is true.

Implementation



ExamplesDeleting a VMware Snapshot

Managing Workflow Orchestration

Submitting a Service RequestObjective

Submit a service request to execute a workflow to execute a set of operations on the resources such aschoosing the VDC on which a VM is provisioned.

Context

Execute a workflow to perform a set of tasks.

Prerequisites

Workflow must be available in Cisco UCS Director. User must be authorized to execute the workflow.

REST URL/app/api/rest?formatType=json&opName=userAPISubmitServiceRequest&opData={param0:"testCatalog",param1:"vdc1",param2:1,param3:-1,param4:1,param5:"provisioningvm"}

Components

Workflow name is required.

Codepublic class UserAPISubmitServiceRequestExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207","1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);int srId = instance.userAPISubmitServiceRequest("testCatalog", "vdc", 1, -1, 1,"UCSD-5.4.0.0");System.out.println("srId "+srId);

}}

Results

Service request ID is returned.

Implementation

Call the userAPISubmitServiceRequest API and pass the workflow name to execute a workflow.

See Also

Submitting a VApp Request

Retrieving Output of a Service Request

Rollback a Workflow


ExamplesManaging Workflow Orchestration

Submitting a VApp RequestObjective

Submit a service request with the advanced catalog type and arguments.

Context

Execute a workflow for advanced catalog type.

Prerequisites

Advanced catalog must be available in Cisco UCS Director.

REST URL/app/api/rest?formatType=json&opName=userAPISubmitVAppServiceRequest&opData={param0:"PjaCat",param1:{"list":[{"name":"Tenant Name","value":"Pja_27"},{"name":"TenantDescription","value":"none"},{"name":"MSP Admin","value":"asa"},{"name":"MSP AdminPassword","value":"asa"},{"name":"MSP Admin Email","value":"asa"},{"name":"Datastore Size(GB)","value":"10"},{"name":"Memory Reservation(MB)","value":"100"},{"name":"No ofCPU","value":"5"},{"name":"No of VDCs","value":"5"},{"name":"L2 Or L3 External NetworkConfiguration","value":"None"},{"name":"L2 VLAN ID","value":""},{"name":"L2 IP Subnet (x.x.x.x/n)","value":""},{"name":"Tenant IP Subnet (x.x.x.x/n)","value":"10.12.18.0/16"},{"name":"ReplicationRequired","value":"No"}]}}

Components

Advanced catalog name

Codepublic class UserAPISubmitVAppServiceRequestExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);APINameValueList list = new APINameValueList();APINameValue nv = new APINameValue();nv.setName("Tenant Name");nv.setValue("Tenant1");nv.setName("Tenant Description");nv.setValue("");nv.setName("Tenant Group");nv.setValue("MSPGroup");list.addNameValue(nv);int srId = instance.userAPISubmitVAppServiceRequest("ExecuteAdvanceCat", list);System.out.println("srId "+srId);}

}

Results

The service request ID is returned.


ExamplesSubmitting a VApp Request

Implementation

Call the userAPISubmitVAppServiceRequest API and pass the advanced catalog name to execute aworkflow for advanced catalog type.

See Also

Submitting a Service Request


Rollback a Workflow

Retrieving Output of a Service RequestObjective

Retrieve the output details of a service request by passing the valid service request ID.

Context

To know the output of a service request.

Prerequisites

Successfully executed service request ID of the workflow must be available in Cisco UCS Director.

REST URL

Request/app/api/rest?formatType=json&opName=servicerequest:userAPIGetServiceRequestOutputDetails&opData={param0:1}

Response{ "serviceResult":{"workflowOutputDetails":[]}, "serviceError":null,"serviceName":"InfraMgr","opName":"servicerequest:userAPIGetServiceRequestOutputDetails" }

Components

param0—The ID of the service request for which you want to view the output.


ExamplesRetrieving Output of a Service Request

Codeimport java.util.List;

import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.UserAPIServiceRequest;import com.cisco.cuic.api.models.UserAPIVMware;import com.cisco.cuic.api.models.servicerequest.APIWorkflowOutputDetails;import com.cisco.cuic.api.models.servicerequest.APIWorkflowOutputFieldDetails;import com.cisco.cuic.api.models.vmware.ServiceDeliveryPolicyRequestParam;

public class ServiceRequestOutputDetailsTest {

public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.22.234.243",

"CF87FA987C8F4BBF814F2BB68CA6A823", "http", 80);

UserAPIServiceRequest instance = new UserAPIServiceRequest(api);APIWorkflowOutputDetails outputDetails =

instance.userAPIGetServiceRequestOutputDetails(1);List<APIWorkflowOutputFieldDetails> outputList

=outputDetails.getWorkflowOutputDetails();

String outputFieldName=outputList.get(0).getOutputFieldName();String outputFieldType=outputList.get(0).getOutputFieldType();String ouputFieldDescription=outputList.get(0).getOutputFieldDescription();String ouputFieldValue=outputList.get(0).getOutputFieldValue();

System.out.println(outputFieldName);System.out.println(outputFieldType);System.out.println(outputFieldType);System.out.println(ouputFieldValue);}}

Results

The output details of the service request is displayed.

Implementation

Call the userAPIGetServiceRequestOutputDetails API and pass the service request ID to view theoutput of the service request.

See Also



Rollback a Workflow


ExamplesRetrieving Output of a Service Request

Rollback a WorkflowObjective

Roll back a workflow to undo a specific operation. A service request ID is generated on successfulrollback of the workflow. A system administrator or an end user can roll back a workflow. The enduser can roll back a service request only when the user role has the Write - Group Service Request userpermission.

If a user rolls back a service request initiated by other user, a rollback workflow approval is triggeredto get approval from the service request initiated user. The rollback workflow is executed after gettingapproval from the service request initiated user.

If a workflow with one or more compound workflow tasks is rolled back, onlyone rollback service request ID is generated. The child service requests are notgenerated for the compound workflow tasks.

Note

Context

Undo the workflow operation.

Prerequisites

Successfully executed service request ID of the workflow must be available in Cisco UCS Director.

REST URL/app/api/rest?formatType=json&opName=userAPIRollbackWorkflow&opData={param0:40}

Components

int srId—The service request ID of the workflow that you want to roll back.

Codepublic class UserAPIRollbackWorkflowExample{public static void main(String[] args) throws Exception{CuicServer server = CuicServer.getAPI("192.0.2.207",

"1A8DE698E2BF4C0B989476A369F0FC64", "https", 443);UserAPIGlobal instance = new UserAPIGlobal(server);int srId = instance.userAPIRollbackWorkflow(123);System.out.println("srId " + srId);}

}

Results

The service request ID is returned.

Implementation

Call the userAPIRollbackWorkflow API and pass the service request ID to roll back a service request.


ExamplesRollback a Workflow

See Also




Retrieving Workflow Fields

Retrieving Input Fields of a Workflow Associated with a CatalogObjective

Retrieve the input fields of a workflow that is associated with an advanced catalog. You can view theinput fields such as input label, name, description, input type, field type, and catalog type of a workflow.

Context

To know the input fields of the workflow associated with the advanced catalog.

Prerequisites

Catalog must be associated with a workflow.

REST URL

Request/app/api/rest?formatType=json&opName=catalog:userAPIGetCatalogInputDefinition&opData={param0:{"catalogName":"AdvCatalog"}}Response{ "serviceResult":{"details":[{"name":"input_0_input1989","label":"input1","description":"","type":"gen_text_input","catalogType":null,"isOptional":false,"inputFieldType":"text","isMultiSelect":false,"inputFieldValidator":null}]},"serviceError":null, "serviceName":"InfraMgr","opName":"catalog:userAPIGetCatalogInputDefinition" }

Components

catalogName—Name of the advanced catalog.


ExamplesRetrieving Workflow Fields

Codepublic class GetCatalogInputDef{public static void main(String[] args) throws Exception {CuicServer api = CuicServer.getAPI("10.23.210.42", "3E17CFFBA7A64C71B8958F40DE2EC9B3","http", 80);UserAPICatalog catalog = new UserAPICatalog(api);APICatalogParams params = new APICatalogParams();params.setCatalogName("AdvCatalog");APIWorkflowInputDetails details = catalog.userAPIGetCatalogInputDefinition(params);

List<APIWorkflowInputDetail> list = null;if(details != null){list = details.getDetails();}else{throw new Exception("No input defination found!");}if(list != null && list.size() > 0){for(int i=0;i<list.size();i++){System.out.println("Field Name: "+list.get(i).getName());System.out.println("Field Label: "+list.get(i).getLabel());System.out.println("Field Description: "+list.get(i).getDescription());System.out.println("Input Type: "+list.get(i).getType());System.out.println("Field Type: "+list.get(i).getInputFieldType());System.out.println("Catalog Type: "+list.get(i).getCatalogType());}}else{System.out.println("No catalog input defination found!");}}}

Results

The input fields of the workflow associated with the catalog are listed.

Sample Result

• Field Name: input_0_input1989

• Field Label: input1

• Field Description:

• Input Type: gen_text_input

• Field Type: text

• Catalog Type: null

Implementation

Use the userAPIGetCatalogInputDefinition API and pass the advanced catalog name associated witha workflow to view the workflow input fields.

See Also

• Retrieving Output Fields of a Workflow Associated with a Catalog, on page 83

• Retrieving Workflow Input Fields, on page 85

• Retrieving Workflow Output Fields, on page 87


ExamplesRetrieving Input Fields of a Workflow Associated with a Catalog

Retrieving Output Fields of a Workflow Associated with a CatalogObjective

Retrieve the output fields of a workflow that is associated with an advanced catalog. You can view theoutput fields such as workflow output label, name, description, and type of a workflow.

Context

To know the output fields of the workflow associated with the advanced catalog.

Prerequisites

Catalog must be associated with a workflow.

REST URL

Request/app/api/rest?formatType=json&opName=catalog:userAPIGetCatalogOutputDefinition&opData={param0:{"catalogName":"AdvCatalog"}}Response{"serviceResult":{"workflowOutputFieldList":[{"outputFieldLabel":”name”,"outputFieldName":"output_0_output1534","outputFieldType":"gen_text_input","outputFieldDescription":""}]},"serviceError":null, "serviceName":"InfraMgr","opName":"catalog:userAPIGetCatalogOutputDefinition" }

Components

catalogName—Name of the advanced catalog.


ExamplesRetrieving Output Fields of a Workflow Associated with a Catalog

Codepublic class GetCatalogOutput{public static void main(String[] args) throws Exception

{CuicServer api = CuicServer.getAPI("172.29.110.241",

"3E17CFFBA7A64C71B8958F40DE2EC9B3", "http", 80);UserAPICatalog catalog = new UserAPICatalog(api);APICatalogParams params = new APICatalogParams();params.setCatalogName("AdvCatalog");APIWorkflowOutputFieldDefinitionList def =

catalog.userAPIGetCatalogOutputDefinition(params);List<APIWorkflowOutputFieldDefinition> list;if(def != null){list = def.getWorkflowOutputFieldList();}else{throw new Exception("No output defination found!");}if(list != null && list.size() > 0){for(int i=0;i< list.size();i++){System.out.println("Field label: "+list.get(i).getOutputFieldLabel());System.out.println("Field name: "+list.get(i).getOutputFieldName());System.out.println("Field description:

"+list.get(i).getOutputFieldDescription());System.out.println("Field type: "+list.get(i).getOutputFieldType());}

}else{throw new Exception("No workflow output field found!");}//System.out.println("lisst = " + list.getWorkflowOutputFieldList().get(0));}

}

Results

The output fields of the workflow associated with the catalog are listed.

Sample Result:

• Field label: output1

• Field name: output_0_output1534

• Field description:

• Field type: gen_text_input

Implementation

Use the userAPIGetCatalogOutputDefinition API and pass the advanced catalog name associated witha workflow to view the workflow output fields.

See Also

• Retrieving Input Fields of a Workflow Associated with a Catalog, on page 81




ExamplesRetrieving Output Fields of a Workflow Associated with a Catalog

Retrieving Workflow Input FieldsObjective

Retrieve the input fields of a workflow. You can view the input fields of the workflow such as inputlabel, name, description, type, and isAdmin input type of a workflow.

Context

To know the input fields of the workflow.

Prerequisites

The workflow must be present in Cisco UCS Director.

REST URL

Request/app/api/rest?formatType=json&opName=userAPIGetWorkflowInputs&opData={param0:"Expand VSAN Cluster"}Response{ "serviceResult":{"details":[{"name":"input_6_VSAN_Cluster915","label":"VSAN Cluster","description":"Select VSAN Cluster","type":"vsanCluster","catalogType":null,"isOptional":false,"inputFieldType":"popup-table","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_3_Host_Nodes50","label":"Host Nodes","description":"Host

Nodes : Ex. 172.29.195.75,172.29.195.76,172.29.195.77","type":"gen_text_input","catalogType":null,"isOptional":false,"inputFieldType":"text","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_2_Host_User_ID924","label":"Host User ID","description":"Enter User ID","type":"gen_text_input","catalogType":null,"isOptional":false,"inputFieldType":"text","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_3_Host_Password766","label":"Host Password","description":"Enter Host Password","type":"password","catalogType":null,"isOptional":false,"inputFieldType":"password","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_6_Host_License325","label":"Host License","description":"","type":"gen_text_input","catalogType":null,"isOptional":true,"inputFieldType":"text","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_5_DVSwitch176","label":"DVSwitch","description":"Select DVSwitch","type":"VMwareDVSwitchIdentity","catalogType":null,"isOptional":false,"inputFieldType":"table","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_9_DVSwitch_Uplink_Portgroup885","label":"DVSwitch Uplink Portgroup","description":"Select Uplink Portgroup,According to DVSwitch","type":"uplinkPortGroupLovList","catalogType":null,"isOptional":false,"inputFieldType":"embedded-lov","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_10_Virtual_SAN_Portgroup153","label":"Virtual SAN Portgroup","description":"Select Virtual SAN Portgroup","type":"VMwareDVPortgroupIdentity","catalogType":null,"isOptional":false,"inputFieldType":"table","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_11_VSAN_IP_Pool_Policy298","label":"VSAN IP Pool Policy","description":"Select VSAN IP Pool Policy","type":"VMWareIPPoolPolicy","catalogType":null,"isOptional":false,"inputFieldType":"popup-table","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_11_vMotion_Portgroup289","label":"vMotion Portgroup","description":"","type":"VMwareDVPortgroupIdentity","catalogType":null,"isOptional":true,"inputFieldType":"table","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_10_vMotion_IP_Pool_Policy807","label":"vMotion IP Pool Policy","description":"","type":"VMWareIPPoolPolicy","catalogType":null,"isOptional":true,"inputFieldType":"popup-table","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false},{"name":"input_7_MTU_Size697","label":"MTU Size","description":"Enter MTU Size,Ex : 1500 or 9000","type":"gen_text_input","catalogType":null,"isOptional":false,"inputFieldType":"text","isMultiSelect":false,"inputFieldValidator":null,"isAdminInput":false}]},

"serviceError":null, "serviceName":"InfraMgr","opName":"userAPIGetWorkflowInputs" }


ExamplesRetrieving Workflow Input Fields

Components

param0—Name of the workflow.

Codepublic class GetWorkflowInputs{public static void main(String[] args) throws Exception{CuicServer api = CuicServer.getAPI("10.23.210.42", "3E17CFFBA7A64C71B8958F40DE2EC9B3","http", 80);UserAPIGlobal instance = new UserAPIGlobal(api);

APIWorkflowInputDetails details = instance.userAPIGetWorkflowInputs("Test1");List<APIWorkflowInputDetail> list = null;

if(details != null){list = details.getDetails();}else{throw new Exception("No workflow input defination found!");}

if(list != null && list.size() > 0){for(int i = 0;i < list.size();i++){System.out.println("Field Name: "+list.get(i).getName());System.out.println("Field Label: "+list.get(i).getLabel());System.out.println("Field Description: "+list.get(i).getDescription());System.out.println("Input Type: "+list.get(i).getType());System.out.println("Field Type: "+list.get(i).getInputFieldType());System.out.println("Is Admin Input Type :"+list.get(i).isAdminInput());}}else{System.out.println("No workflow input found!");}

}}

Results

The input fields of the workflow are listed.

Sample Result:

• Field Name: input_0_name250

• Field Label: name

• Field Description: person name

• Input Type: gen_text_input

• Field Type: text

• Is Admin Input Type : false

Implementation

Use the userAPIGetWorkflowInputs API and pass the workflow name to view the workflow inputfields.


ExamplesRetrieving Workflow Input Fields

See Also




Retrieving Workflow Output FieldsObjective

Retrieve the output fields of a workflow. You can retrieve the output fields such as output label, name,description, and type of a workflow.

Context

To know the output fields of the workflow.

Prerequisites

None

REST URL

Request/app/api/rest?formatType=json&opName=workflow:userAPIGetWorkflowOutputDefinition&opData={param0:"Test1"}Response{ "serviceResult":{"workflowOutputFieldList":[{"outputFieldLabel":"OUTPUT_NAME","outputFieldName":"output_0_OUTPUT_NAME75","outputFieldType":"gen_text_input","outputFieldDescription":"person's name"}]}, "serviceError":null,"serviceName":"InfraMgr","opName":"workflow:userAPIGetWorkflowOutputDefinition" }

Components

param0—Name of the workflow for which you want to view the output fields.


ExamplesRetrieving Workflow Output Fields

Codepublic class GetWorkflowOutputDef{public static void main(String[] args) throws Exception{CuicServer api = CuicServer.getAPI("10.23.210.42", "3E17CFFBA7A64C71B8958F40DE2EC9B3","http", 80);UserAPIWorkflow instance = new UserAPIWorkflow(api);APIWorkflowOutputFieldDefinitionList def =

instance.userAPIGetWorkflowOutputDefinition("Test1");List<APIWorkflowOutputFieldDefinition> list =null;if(def != null){list = def.getWorkflowOutputFieldList();}else{throw new Exception("No workflow output defination found!");}if(list != null && list.size() > 0){for(int i=0;i<list.size();i++){System.out.println("Field Name: "+list.get(i).getOutputFieldName());System.out.println("Field Label: "+list.get(i).getOutputFieldLabel());System.out.println("Field Description: "+list.get(i).getOutputFieldDescription());

System.out.println("Field Type: "+list.get(i).getOutputFieldType());}}else{System.out.println("No workflow output field found!");}}}

Results

The output fields of the workflow are listed.

Sample Result:

• Field Name: output_0_OUTPUT_NAME75

• Field Label: OUTPUT_NAME

• Field Description: person's name

• Field Type: gen_text_input

Implementation

Use the userAPIGetWorkflowOutputDefinition API and pass the workflow name to view the workflowoutput fields.

See Also





ExamplesRetrieving Workflow Output Fields

Managing MSP

Toggling MSP ModeObjective

Enable or disable Managed Service Provider (MSP) mode in Cisco UCS Director.

Context

The MSP mode must be enabled to access MSP users or MSP organization in Cisco UCS Director.

Prerequisites

None

Post Requisites

Restart the Cisco UCS Director services.

REST URL/app/api/rest?formatType=json&opName=auth:userAPIToggleMspMode&opData={param0:{"action":true,"tenantName":"sample","orgName":"sample"}}

Components

The parameters of the userAPIToggleMspMode API are:

• action—Set the value as true to enable the MSP mode. Set the value as false to disable the MSPmode.

• tenantName—The name of theMSP user. This parameter is optional for theMSP disable operation.

• orgName—The name of the MSP organization. This parameter is optional for the MSP disableoperation.

Codepublic static void main(String[] args) throws Exception{CuicServer api = CuicServer.getAPI("172.29.110.241",

"3E17CFFBA7A64C71B8958F40DE2EC9B3", "http", 80);UserAPIAuthConfig instance = new UserAPIAuthConfig(api);APIMSPModeParams params = new APIMSPModeParams();params.setAction(true);params.setTenantName("MSP Users");params.setOrgName("MSP Organization");String result = instance.userAPIToggleMspMode(params);System.out.println("Result: "+result);}


ExamplesManaging MSP

Results

The status message is displayed according to the set MSP mode.

• If the MSP mode is enabled, the following message is displayed:MSP Mode is enabled successfully. Restart the Cisco UCS Director services toreflect the changes.

• If the MSP mode is disabled, the following message is displayed:MSP Mode is disabled successfully. Restart the Cisco UCS Director services toreflect the changes.

Implementation

Pass the MSP user name and MSP organization name, and set the action as true in theuserAPIToggleMspMode API to enable the MSP mode.

Managing Reports

Viewing Available Reports DefinitionObjective

You can use the userAPIGetAvailableReports API to view the type, ID, and label of all the reports thatare available in Cisco UCS Director for the given contextName and contextValue.

Context

To view the definition of reports that are available for the given contextName and contextValue.

Prerequisites

The given contextName and contextValue must be available in Cisco UCS Director.


ExamplesManaging Reports

REST URL

Request/app/api/rest?formatType=json&opName=userAPIGetAvailableReports&opData={param0:"22",param1:"Jha_VDC_VMware_82"}

Response{ "serviceResult":[{"reportLabel":"Summary","reportId":"SUMMARY-V0","reportType":"tabular"},{"reportLabel":"Summary","reportId":"SUMMARY-V14","reportType":"tabular"},{"reportLabel":"VMs","reportId":"VMS-T0","reportType":"tabular"},{"reportLabel":"Events","reportId":"EVENTS-T0","reportType":"tabular"},{"reportLabel":"Static IP Assignment","reportId":"STATIC-IP-ASSIGNMENT-T0","reportType":"tabular"},{"reportLabel":"Deleted VMs","reportId":"DELETED-VMS-T0","reportType":"tabular"},{"reportLabel":"VDC Compliance on VMs","reportId":"VDC-COMPLIANCE-ON-VMS-T0","reportType":"tabular"},{"reportLabel":"Trend:vDC CPUUsage","reportId":"TREND-VDC-CPU-USAGE-H0","reportType":"trend"},{"reportLabel":"Trend:vDC MemoryUsage","reportId":"TREND-VDC-MEMORY-USAGE-H0","reportType":"trend"},{"reportLabel":"Trend:vDC DiskUsage","reportId":"TREND-VDC-DISK-USAGE-H0","reportType":"trend"},{"reportLabel":"Trend:vDC NetworkUsage","reportId":"TREND-VDC-NETWORK-USAGE-H0","reportType":"trend"},{"reportLabel":"Trend:Numberof VMs","reportId":"TREND-NUMBER-OF-VMS-H0","reportType":"trend"},{"reportLabel":"Trend:VM Additions

& Deletions","reportId":"TREND-VM-ADDITIONS-&-DELETIONS-H0","reportType":"trend"},{"reportLabel":"Trend: vDC CPU Usage (GHz)","reportId":"TREND-VDC-CPU-USAGE-(GHZ)-H14","reportType":"trend"},{"reportLabel":"Trend: vDC Memory Usage GB","reportId":"TREND-VDC-MEMORY-USAGE-GB-H14","reportType":"trend"},{"reportLabel":"Trend: vDC Disk Usage","reportId":"TREND-VDC-DISK-USAGE-H14","reportType":"trend"},{"reportLabel":"Trend: vDCNetwork Usage","reportId":"TREND-VDC-NETWORK-USAGE-H14","reportType":"trend"},{"reportLabel":"Trend: Number ofVMs","reportId":"TREND-NUMBER-OF-VMS-H14","reportType":"trend"},{"reportLabel":"Trend: VM Additions &Deletions","reportId":"TREND-VM-ADDITIONS-&-DELETIONS-H14","reportType":"trend"},{"reportLabel":"Trend: Total Cost","reportId":"TREND-TOTAL-COST-H0","reportType":"trend"},{"reportLabel":"Trend: VM Cost","reportId":"TREND-VM-COST-H0","reportType":"trend"},{"reportLabel":"Trend: CPU Cost","reportId":"TREND-CPU-COST-H0","reportType":"trend"},{"reportLabel":"Trend: Memory Cost","reportId":"TREND-MEMORY-COST-H0","reportType":"trend"},{"reportLabel":"Trend: Network Cost","reportId":"TREND-NETWORK-COST-H0","reportType":"trend"},{"reportLabel":"Trend: Total Cost","reportId":"TREND-TOTAL-COST-H14","reportType":"trend"},{"reportLabel":"Trend: VM Cost","reportId":"TREND-VM-COST-H14","reportType":"trend"},{"reportLabel":"Trend: CPU Cost","reportId":"TREND-CPU-COST-H14","reportType":"trend"},{"reportLabel":"Trend: Memory Cost","reportId":"TREND-MEMORY-COST-H14","reportType":"trend"},{"reportLabel":"Trend: NetworkCost","reportId":"TREND-NETWORK-COST-H14","reportType":"trend"},{"reportLabel":"Trend:Snapshot FileSize","reportId":"TREND-SNAPSHOT-FILE-SIZE-H0","reportType":"trend"},{"reportLabel":"VMs","reportId":"VMS-T14","reportType":"tabular"},{"reportLabel":"Events","reportId":"EVENTS-T14","reportType":"tabular"},{"reportLabel":"DeletedVMs","reportId":"DELETED-VMS-T14","reportType":"tabular"},{"reportLabel":"Chargeback","reportId":"CHARGEBACK-T12","reportType":"tabular"},{"reportLabel":"Resource Accounting","reportId":"RESOURCE-ACCOUNTING-T12","reportType":"tabular"},{"reportLabel":"ResourceAccounting Details","reportId":"RESOURCE-ACCOUNTING-DETAILS-T12","reportType":"tabular"},{"reportLabel":"CPU Usage (MHz)","reportId":"CPU-USAGE-(MHZ)-S0","reportType":"snapshot"},{"reportLabel":"Memory Usage (GB)","reportId":"MEMORY-USAGE-(GB)-S0","reportType":"snapshot"},{"reportLabel":"Disk Usage (GB)","reportId":"DISK-USAGE-(GB)-S0","reportType":"snapshot"},{"reportLabel":"Number of Events by Severity","reportId":"NUMBER-OF-EVENTS-BY-SEVERITY-S0","reportType":"snapshot"},{"reportLabel":"CPU Usage (MHz)","reportId":"CPU-USAGE-(MHZ)-S14","reportType":"snapshot"},{"reportLabel":"Memory Usage(GB)","reportId":"MEMORY-USAGE-(GB)-S14","reportType":"snapshot"},{"reportLabel":"Disk Usage (GB)","reportId":"DISK-USAGE-(GB)-S14","reportType":"snapshot"}], "serviceError":null, "serviceName":"InfraMgr","opName":"userAPIGetAvailableReports" }


ExamplesViewing Available Reports Definition

Components

The parameters of the userAPIGetAvailableReports API are:

• String param0—The name of the report context.

• int param1—The value of the report context.

For more information on the name and value of the report context, see the Appendix B: Report ContextTypes and Report Context Names appendix in the Cisco UCS Director Open Automation Cookbook.

Codeimport java.util.List;import com.cisco.cuic.api.models.UserAPIGlobal;import com.cisco.cuic.api.client.APIReportDefinition;import com.cisco.cuic.api.client.CuicServer;

public class TestuserAPIGetAvailableReports {

public static void main(String[] args) throws Exception {CuicServer server =

CuicServer.getAPI("172.29.110.222","96408900345D40C0BC889E4F41C2E094", "https", 443);

UserAPIGlobal instance = new UserAPIGlobal(server);List<APIReportDefinition>

apiReportDefinitionList=instance.userAPIGetAvailableReports("22", "Jha_VDC_VMware-82");

int i=0;for(APIReportDefinition apiReportDefinition: apiReportDefinitionList){System.out.println("Report_"+i);System.out.println("reportLabel: "+apiReportDefinition.getReportLabel());System.out.println("reportID: "+apiReportDefinition.getReportId());System.out.println("reportType: "+apiReportDefinition.getReportType());i++;}

}}

Results

The type, ID, and label of reports that are available for the given contextName and contextValue aredisplayed.

Implementation

Use the userAPIGetAvailableReports API and pass the contextName and contextValue to view the listof API report definitions for the given contextName and contextValue.

See Also

Viewing Historical Report

Viewing Resource Usage Report

Viewing Snapshot Report

Viewing Tabular Reports


ExamplesViewing Available Reports Definition

http://www.cisco.com/c/en/us/support/servers-unified-computing/ucs-director/products-programming-reference-guides-list.html

Viewing Historical ReportObjective

You can use the userAPIGetHistoricalReport API to view the historical data of a report context, suchas VDC CPU usage trend report, for a specific time period. The report context refers to contextName,contextValue, and reportId.

Context

To view the historical data of a report context for a specific time period.

Prerequisites

The given contextName and contextValue must be available in Cisco UCS Director. The time periodmust be one of the specified durations in Cisco UCS Director or the custom time period in the formatsupported by Cisco UCS Director.

REST URL

Request/app/api/rest?formatType=json&opName=userAPIGetHistoricalReport&opData={param0:"22",param1:"2",param2:"TREND-VDC-CPU-USAGE-H0",param3:"hourly"}

Response{ "serviceResult":{"series":[{"paramName":"vdc.cpu.usage.average:gigaHertz","paramLabel":"CPU Usage (GHz)","values":[{"timestamp":1467594752222,"min":0.0,"max":0.0,"avg":0.165},{"timestamp":1467598352222,"min":0.0,"max":0.0,"avg":0.165}],"precision":2,"units":""}]},

"serviceError":null, "serviceName":"InfraMgr", "opName":"userAPIGetHistoricalReport" }

Components

The parameters of the userAPIGetHistoricalReport API are:



• int param2—The unique identifier of the report.

• int Param3—The time duration for which you want to generate the historical report. The predefinedvalid time durations are hourly, daily, weekly, and monthly. The custom time duration must startwith the prefix “custom:”.

For more information on the name and value of the report context, see the Appendix B: Report ContextTypes and Report Context Names in the Cisco UCS Director Open Automation Cookbook.


ExamplesViewing Historical Report


Codeimport java.util.List;import com.cisco.cuic.api.client.APIHistoricalReport;import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.client.DataSample;import com.cisco.cuic.api.client.HistoricalDataSeries;import com.cisco.cuic.api.models.UserAPIGlobal;

public class TestuserAPIGetHistoricalReport {



UserAPIGlobal instance = new UserAPIGlobal(server);APIHistoricalReport historicalReport=instance.userAPIGetHistoricalReport("22", "2","TREND-VDC-CPU-USAGE-H0", "hourly");List<HistoricalDataSeries> historicalDataSeriesList = historicalReport.getSeries();

int i=0;for(HistoricalDataSeries hds: historicalDataSeriesList){System.out.println("****Series_"+i+"****");System.out.println("paramName: "+hds.getParamName());System.out.println("paramLabel: "+hds.getParamLabel());DataSample[] dataSampleArr=hds.getValues();for(DataSample ds:dataSampleArr ){System.out.println("timestamp: "+ds.getTimestamp());System.out.println("min: "+ds.getMin());System.out.println("max: "+ds.getMax());System.out.println("avg: "+ ds.getAvg());}System.out.println("precision: "+hds.getPrecision());System.out.println("units: "+hds.getUnits());i++;}}}

Results

The historical data of a report context for a specific time period is displayed.

Implementation

Use the userAPIGetHistoricalReport API and pass the contextName, contextValue, and time durationto view the historical data of a report context for a specific time period.

See Also

Viewing Available Reports Definition





ExamplesViewing Historical Report

Viewing Resource Usage ReportObjective

The report of resources used in the cloud infrastructure management can be viewed using theuserAPIGetResourceUsageCostSummary API. Using this API, administrator and end user can viewthe daily, weekly, and monthly resource usage report.

Context

To view the infrastructure utilization or cost reporting of resources on daily, weekly, or monthly basis.

Prerequisites

None


ExamplesViewing Resource Usage Report

REST URL



This section provides the REST URL for viewing resource usage report in different scenarios:Example 1: Daily usage report of a virtual machine (VM) without resourceName

Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"vmid","value":"56"}],"fromTimeInMilliSeconds":1442946600000,"toTimeInMilliSeconds":1443032999000}}Response{ "serviceResult":{"resourceType":"VM","duration":"Daily_22_9_2015","responseParamList":{"list":[{"name":"vmid","value":"56"}]},"resourceUsageCostSummary":[{"groupId":1,"groupName":"Default Group","vdcId":0,"onetimeCost":8.0,"activeCost":56.0,"inactiveCost":4.0,"applicationCost":23.0,"totalCost":5.0,"fixedCost":4.0,"catalogItemName":"SDK","cpuResourceUsageCost":{"cpu_GHz_Hours":111.99998388000004,"cpuCost":4.0,"reservedCpuGhzCost":9.0,"usedCpuGhzCost":65.0,"reservedCpuGhz":0.0,"usedCpuGhz":0.0,"cpuCores":40,"cpuCoreCost":56.0}],"diskResourceUsageCost":[{"committedDiskGB":40.60000000000001,"uncommittedDiskGB":1.4000000000000008,"committedDiskGBCost":56.0,"uncommittedDiskGBCost":567.0}],"memoryResourceUsageCost":[{"memory":67.0,"memoryCost":67.0,"reservedMemoryGBCost":7.0,"usedMemoryGBCost":12.0,"usedMemoryGB":0.0,"reservedMemoryGB":0.0}],"networkResourceUsageCost":[{"netRxUsageGB":0.0,"netTxUsageGB":76.0,"netRxUsageGBCost":0.00006389617919921875,"netTxUsageGBCost":0.00008296966552734375}],"physicalServerResourceUsageCost":[{"halfLengthBlade":false,"bladeType":"","fullBladeCost":67.0,"halfBladeCost":76.0,"serverCost":5.0}]}]}, "serviceError":null, "serviceName":"InfraMgr","opName":"chargeback:userAPIGetResourceUsageCostSummary" }

Example 2: Daily usage report of a group without resourceName

Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"Group","value":"Default Group"}],"fromTimeInMilliSeconds":1442946600000,"toTimeInMilliSeconds":1443032999000}}Response{ "serviceResult":{"resourceType":null,"duration":"Daily_22_9_2015","responseParamList":{"list":[{"name":"Group","value":"Default Group"}]},"resourceUsageCostSummary":[{"groupId":1,"groupName":"Default Group","vdcId":0,"onetimeCost":8.0,"activeCost":56.0,"inactiveCost":4.0,"applicationCost":23.0,"totalCost":5.0,"fixedCost":4.0,"catalogItemName":"SDK","cpuResourceUsageCost":[{"cpu_GHz_Hours":351.99997083999995,"cpuCost":4.0,"reservedCpuGhzCost":9.0,"usedCpuGhzCost":65.0,"reservedCpuGhz":0.0,"usedCpuGhz":0.0,"cpuCores":120,"cpuCoreCost":56.0}],"diskResourceUsageCost":[{"committedDiskGB":1225.1200000000001,"uncommittedDiskGB":3974.999999999999,"committedDiskGBCost":56.0,"uncommittedDiskGBCost":567.0}],"memoryResourceUsageCost":[{"memory":240.0,"memoryCost":67.0,"reservedMemoryGBCost":7.0,"usedMemoryGBCost":12.0,"usedMemoryGB":0.0,"reservedMemoryGB":0.0}],"networkResourceUsageCost":[{"netRxUsageGB":0.0,"netTxUsageGB":76.0,"netRxUsageGBCost":0.00006389617919921875,"netTxUsageGBCost":0.00008296966552734375}],"physicalServerResourceUsageCost":[{"halfLengthBlade":false,"bladeType":"","fullBladeCost":67.0,"halfBladeCost":76.0,"serverCost":5.0}]}]}, "serviceError":null, "serviceName":"InfraMgr","opName":"chargeback:userAPIGetResourceUsageCostSummary" }

Example 3: Daily usage report of a virtual data center (VDC) without resourceName

Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"vdcid","value":"1"}],"fromTimeInMilliSeconds":1442946600000,"toTimeInMilliSeconds":1443032999000}}Response{ "serviceResult":{"resourceType":null,"duration":"Daily_22_9_2015","responseParamList":{"list":[{"name":"vdcName","value":"Default vDC"}]},"resourceUsageCostSummary":[{"groupId":1,"groupName":"Default Group","vdcId":0,"onetimeCost":8.0,"activeCost":56.0,"inactiveCost":4.0,"applicationCost":23.0,"totalCost":5.0,"fixedCost":4.0,"catalogItemName":"SDK","cpuResourceUsageCost":[{"cpu_GHz_Hours":351.99997083999995,"cpuCost":4.0,"reservedCpuGhzCost":9.0,"usedCpuGhzCost":65.0,"reservedCpuGhz":0.0,"usedCpuGhz":0.0,"cpuCores":120,"cpuCoreCost":56.0}],"diskResourceUsageCost":[{"committedDiskGB":1225.1200000000001,"uncommittedDiskGB":3974.999999999999,"committedDiskGBCost":56.0,



"uncommittedDiskGBCost":567.0}],"memoryResourceUsageCost":[{"memory":240.0,"memoryCost":67.0,"reservedMemoryGBCost":7.0,"usedMemoryGBCost":12.0,"usedMemoryGB":0.0,"reservedMemoryGB":0.0}],"networkResourceUsageCost":[{"netRxUsageGB":0.0,"netTxUsageGB":76.0,"netRxUsageGBCost":0.00006389617919921875,"netTxUsageGBCost":0.00008296966552734375}],"physicalServerResourceUsageCost":[{"halfLengthBlade":false,"bladeType":"","fullBladeCost":67.0,"halfBladeCost":76.0,"serverCost":5.0}]}]}, "serviceError":null, "serviceName":"InfraMgr","opName":"chargeback:userAPIGetResourceUsageCostSummary" }

Example 4: Daily usage report of a CPU in a VM

Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"vmid","value":"56"},{"name":"resourceName","value":"CPU"}],"fromTimeInMilliSeconds":1442946600000,"toTimeInMilliSeconds":1443032999000}}Response{ "serviceResult":{"resourceType":"VM","duration":"Daily_22_9_2015","responseParamList":{"list":[{"name":"vmid","value":"56"}]},"resourceUsageCostSummary":[{"groupId":1,"groupName":"Default Group","vdcId":0,"onetimeCost":8.0,"activeCost":56.0,"inactiveCost":4.0,"applicationCost":23.0,"totalCost":5.0,"fixedCost":4.0,"catalogItemName":"SDK","cpuResourceUsageCost":{"cpu_GHz_Hours":111.99998388000004,"cpuCost":4.0,"reservedCpuGhzCost":9.0,"usedCpuGhzCost":2.6,"reservedCpuGhz":0.0,"usedCpuGhz":0.0,"cpuCores":40,"cpuCoreCost":56.0}],"diskResourceUsageCost":null,"memoryResourceUsageCost":null,"networkResourceUsageCost":null,"physicalServerResourceUsageCost":null}]}, "serviceError":null,"serviceName":"InfraMgr", "opName":"chargeback:userAPIGetResourceUsageCostSummary" }

Example 5: Daily usage report of a disk in a group

Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"Group","value":"Default Group"},{"name":"resourceName","value":"disk"}],"fromTimeInMilliSeconds":1442946600000,"toTimeInMilliSeconds":1443032999000}}Response{ "serviceResult":{"resourceType":null,"duration":"Daily_22_9_2015","responseParamList":{"list":[{"name":"Group","value":"Default Group"}]},"resourceUsageCostSummary":[{"groupId":1,"groupName":"Default Group","vdcId":0,"onetimeCost":8.0,"activeCost":56.0,"inactiveCost":4.0,"applicationCost":23.0,"totalCost":5.0,"fixedCost":4.0,"catalogItemName":"SDK","cpuResourceUsageCost":null,"diskResourceUsageCost":[{"committedDiskGB":1225.1200000000001,"uncommittedDiskGB":3974.999999999999,"committedDiskGBCost":56.0,"uncommittedDiskGBCost":567.0}],"memoryResourceUsageCost":null,"networkResourceUsageCost":null,"physicalServerResourceUsageCost":null}]},"serviceError":null, "serviceName":"InfraMgr","opName":"chargeback:userAPIGetResourceUsageCostSummary" }

Example 6: Daily usage report of a VM in VDC



Request/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"vdcid","value":"1"},{"name":"resourceName","value":"VM"}],"fromTimeInMilliSeconds":1442946600000,"toTimeInMilliSeconds":1443032999000}}Response{ "serviceResult":{"resourceType":null,"duration":"Daily_22_9_2015","responseParamList":{"list":[{"name":"vdcName","value":"Default vDC"}]},"resourceUsageCostSummary":[{"groupId":1,"groupName":"Default Group","vdcId":0,"onetimeCost":8.0,"activeCost":56.0,"inactiveCost":4.0,"applicationCost":23.0,"totalCost":5.0,"fixedCost":4.0,"catalogItemName":"SDK","cpuResourceUsageCost":[{"cpu_GHz_Hours":351.99997083999995,"cpuCost":4.0,"reservedCpuGhzCost":9.0,"usedCpuGhzCost":65.0,"reservedCpuGhz":0.0,"usedCpuGhz":0.0,"cpuCores":0,"cpuCoreCost":56.0}],"diskResourceUsageCost":[{"committedDiskGB":1225.1200000000001,"uncommittedDiskGB":3974.999999999999,"committedDiskGBCost":56.0,"uncommittedDiskGBCost":567.0}],"memoryResourceUsageCost":[{"memory":240.0,"memoryCost":67.0,"reservedMemoryGBCost":7.0,"usedMemoryGBCost":12.0,"usedMemoryGB":0.0,"reservedMemoryGB":0.0}],"networkResourceUsageCost":[{"netRxUsageGB":0.0,"netTxUsageGB":76.0,"netRxUsageGBCost":0.00006389617919921875,"netTxUsageGBCost":0.00008296966552734375}],"physicalServerResourceUsageCost":null}]},

"serviceError":null, "serviceName":"InfraMgr","opName":"chargeback:userAPIGetResourceUsageCostSummary" }

Components

The parameters of the userAPIGetResourceUsageCostSummary API are:

• APINameValueList requestParam—List of requested report parameters in the name and valuepair format. The possible values of name are vmId, vdcName, groupName, and resourceName.If the resourceName is passed as the name, the possible values of resourceName are cpu, disk,memory, VM, BM, network, or empty value (" ").

The possible combination of parameters for viewing the resource usage report:resourceNameName

CPU /Disk/VM/BM/Memory/Networkvmid

Diskvdcid

VMGroup

Nonevmid

Nonevdcid

NoneGroup

• fromTimeInMilliSeconds—The start time of the report in milliseconds. For example, the dateand time string Mon Feb 16 2015 00:00:00 GMT-0400 (Eastern Daylight Time) is representedas 1424059200000 in milliseconds.

• toTimeInMilliSeconds—The end time of the report in milliseconds. For example, the date andtime string Sun Feb 22 2015 00:00:00 GMT-0400 (Eastern Daylight Time) is represented as1424577600000 in milliseconds.



Codepublic class GetResourceUsageCostSummaryTest {

public static void main(String[] args)throws Exception {CuicServer api = CuicServer.getAPI("172.29.110.128",

"3E17CFFBA7A64C71B8958F40DE2EC9B3", "http", 80);UserAPIChargeBack instance = new UserAPIChargeBack(api);APIResourceUsageCostParams costParams = new APIResourceUsageCostParams();APINameValue value=new APINameValue();value.setName("vmid");value.setValue("56");List<APINameValue> requestParam=new ArrayList<APINameValue>();

requestParam.add(value);costParams.setRequestParam(requestParam);costParams.setFromTimeInMilliSeconds(1442946600000l);costParams.setToTimeInMilliSeconds(1443032999000l);

APIResourceUsageCostSummaryResponse response =instance.userAPIGetResourceUsageCostSummary(costParams);System.out.println("Duration :" +response.getDuration());System.out.println("ResourceType :" +response.getResourceType());APINameValueList list=response.getResponseParamList();List<APINameValue> apivalue= list.getList();for(int i=0;i<apivalue.size();i++){System.out.println("Name :" + apivalue.get(i).getName());System.out.println("Value :" + apivalue.get(i).getValue());}

List<APIResourceUsageCostSummary> summary=response.getResourceUsageCostSummary();for(int i=0;i<summary.size();i++){System.out.println("catalogItemName :" + summary.get(i).getCatalogItemName());//System.out.println("cpuResourceUsageCost" +

summary.get(i).getCpuResourceUsageCost());

APICPUResourceUsageCost[] cpus=summary.get(i).getCpuResourceUsageCost();for(int j=0;j<cpus.length;j++){System.out.println("Cpu_GHz_Hours : " + cpus[j].getCpu_GHz_Hours());System.out.println("CPU CoreCost : " + cpus[j].getCpuCoreCost());System.out.println("Cpu Cores :" + cpus[j].getCpuCores());System.out.println("Cpu Cost :" + cpus[j].getCpuCost());System.out.println("Reserved CpuGHZCost" + cpus[j].getReservedCpuGhzCost());System.out.println("Used Cpu Cost" + cpus[j].getUsedCpuGhzCost());}}}}

Results

The requested resource usage report is displayed.

Implementation

Use the userAPIGetResourceUsageCostSummary API and pass the report parameter in the name andvalue format to view the resource usage report.



See Also

Sample code for viewing monthly resource usage report:/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"vmid","value":"56"},{"name":"resourceName","value":"CPU"}],"fromTimeInMilliSeconds":1441081800000,"toTimeInMilliSeconds":1443587400000}}Sample code for viewing weekly resource usage report:/app/api/rest?formatType=json&opName=chargeback:userAPIGetResourceUsageCostSummary&opData={param0:{"requestParam":[{"name":"vmid","value":"56"},{"name":"resourceName","value":"CPU"}],"fromTimeInMilliSeconds":1442982600000,"toTimeInMilliSeconds":1443587400000}}

The possible combination of inputs for viewing the report are:

• Monthly/weekly/daily timestamp, vmid, and resourceName as CPU, Disk, VM, BM, memory, ornetwork.

• Monthly/weekly/daily timestamp, vdcid, and resourceName as CPU, Disk, VM, BM, memory,or network.

• Monthly/weekly/daily timestamp, Group, and resourceName as CPU, Disk, VM, BM, memory,or network.

• Monthly/weekly/daily timestamp, vmid without any resourceName.

• Monthly/weekly/daily timestamp, vdcid without any resourceName.

• Monthly/weekly/daily timestamp, Group without any resourceName.





Viewing Snapshot ReportObjective

You can view the snapshot of a report context using the userAPIGetInstantDataReport API. The reportcontext refers to contextName, contextValue, and reportId.

Context

To view the snapshot of a report context.

Prerequisites

The given contextName, contextValue, and reportId must be available in Cisco UCS Director.


ExamplesViewing Snapshot Report

REST URL

Request/app/api/rest?formatType=json&opName=userAPIGetInstantDataReport&opData={param0:"1",param1:"Jha_Vmware_Cloud_82",param2:"VMS-ACTIVE-VS-INACTIVE-S0"}

Response{ "serviceResult":{"categoryAxisName":null,"valueAxisName":"Active vs Inactive","categories":[{"categoryName":"","nameValuePairs":[{"name":"Active VMs","value":"42"},{"name":"Inactive VMs","value":"29"}]}]}, "serviceError":null, "serviceName":"InfraMgr",

"opName":"userAPIGetInstantDataReport" }

Components

The parameters of the userAPIGetInstantDataReport API are:



• int param2—The unique identifier of the report.

For more information on the name and value of the report context, see the Appendix B: Report ContextTypes and Report Context Names in the Cisco UCS Director Open Automation Cookbook.

Codeimport java.util.List;import com.cisco.cuic.api.models.UserAPIGlobal;import com.cisco.cuic.api.client.APISnapshotReport;import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.client.ReportNameValuePair;import com.cisco.cuic.api.client.SnapshotReportCategory;

public class TestuserAPIGetInstantDataReport {



UserAPIGlobal instance = new UserAPIGlobal(server);APISnapshotReport apiSanpshotReport=instance.userAPIGetInstantDataReport("1",

"Jha_Vmware_Cloud_82", "VMS-ACTIVE-VS-INACTIVE-S0");System.out.println("categoryAxisName: "+apiSanpshotReport.getCategoryAxisName());System.out.println("valueAxisName: "+apiSanpshotReport.getValueAxisName());List<SnapshotReportCategory> snapshotReportCategoryList=

apiSanpshotReport.getCategories();int i=0;for(SnapshotReportCategory snapshotReportCategory:snapshotReportCategoryList){System.out.println("Category_"+i);System.out.println("categoryName: "+snapshotReportCategory.getCategoryName());int j=0;ReportNameValuePair[]

reportNameValuePairArr=snapshotReportCategory.getNameValuePairs();for(ReportNameValuePair reportNameValuePair:reportNameValuePairArr ){System.out.println("ReportNameValuePair_"+j);System.out.println("name: "+reportNameValuePair.getName());System.out.println("value: "+reportNameValuePair.getValue());j++;}i++;}}}


ExamplesViewing Snapshot Report


Results

The snapshot of the given report context is displayed.

Implementation

Use the userAPIGetInstantDataReport API and pass the contextName, contextValue, and reportId toview the snapshot of the given report context.

See Also





Viewing Tabular ReportsObjective

You can use the userAPIFilterTabularReport API to view a set of tabular reports that are filtered basedon a particular context.

Context

To view the tabular reports for a particular context.

Prerequisites

A context must be available in Cisco UCS Director.

REST URL

Request/app/api/rest?formatType=json&opName=userAPIFilterTabularReport&opData={param0:"1",param1:"VMware70",param2:"VMS-T0",param3:"VM-ID",param4:"1"}

Response{ "serviceResult":{"rows":[{"Cloud":"VMware70","VM_ID":1,"User_Label":"","VM_Name":"vm-QA-SR169","Host_Name":null,"IP_Address":"","Image_Id":"vm-QA-SR169","Host_Node":"10.28.106.71","Power_Status":"ON","Group_Name":"Default Group","vDC":"test vdc","Category":"Discovered VM","Provisioned_Time":"","Scheduled_Termination_Time":"","Last_Status_Update":"May 18, 2016 02:35:32 UTC","Guest_OS_Type":"Red Hat Enterprise Linux 4 (32-bit)"}],"columnMetaData":null,"reportParams":{}}, "serviceError":null, "serviceName":"InfraMgr","opName":"userAPIFilterTabularReport" }


ExamplesViewing Tabular Reports

Components

• param0—The name of the context.

• param1—The value of the context.

• param2—The ID of the report.

• param3—Column label.

• param4—Column value.

Codeimport com.cisco.cuic.api.client.APITabularReport;import com.cisco.cuic.api.client.CuicServer;import com.cisco.cuic.api.models.UserAPIGlobal;import com.cisco.cuic.api.models.UserAPIServiceRequest;

public class TestuserAPIGetTabularReport{public static void main(String[] args)throws Exception{CuicServer api = CuicServer.getAPI("172.22.234.243","CF87FA987C8F4BBF814F2BB68CA6A823", "http", 80);UserAPIGlobal instance = new UserAPIGlobal(api);APITabularReport report=instance.userAPIFilterTabularReport("0", "All%20Clouds","VMS-T0","VM-ID","9");System.out.println(report.getRowCount());}}

Results

The tabular report for a specific context is filtered and displayed.

Implementation

Use the userAPIFilterTabularReport API and pass the report parameter to view the tabular report.

See Also






ExamplesViewing Tabular Reports