Chapter 1. New and Changed APIs in the Current Release

Overview

JSON REST API

XML REST API

Internal API

Java Reports

Chapter 1. New and Changed APIs in the Current Release

New and Changed APIs for Cisco UCS Director, Release 6.0

First Published: September 16, 2016

Overview

This guide provides the list of new and changed APIs for the current release.

- JSON REST API—Provides a list of the changes made to the JavaScript Object Notation (JSON) REST APIs.

- XML REST API—Provides a list of the classes that were added to the XML REST APIs. This section also provides information about new and modified input and output parameters for those classes.

- Internal API—Provides a list of modified and deleted methods for the pojos of the internal APIs.

- Java Report Files—Provides a list of reports in which new columns are added for the current release.

JSON REST API

There is no change in JSON REST APIs for Release 6.0 compared with Release 5.5.

XML REST API

This section provides a list of classes that are newly added for the current release. Also, this section provides the number of newly added and modified input and output parameters of the classes for Release 6.0 in comparison with Release 5.5.

New API

The following table provides the list of newly added XML REST APIs for Release 6.0 in comparison with Release 5.5.

API Name

Parameters

AddPhysicalNetworkDeviceConfig

private String podName;

private String deviceCategory;

private String serverAddress;

private String protocol = "ssh";

private int port = 22;

private String username;

private String password;

private String enablePassword;

private long actionId;

private long configEntryId;

BaremetalProvisioningWrapperConfig

private long configEntryId;

private long actionId;

private boolean useExplicitPolicy = false;

private int bmPolicyId;

CIMCAaaUserPolicy

private String accountName;

private String serverIP;

private String dn;

private String userPasswordPolicy;

private String passwordPolicyRules;

CIMCZoning

private long configEntryId;

private long actionId;

private String accountName;

private String serverIP;

private String slot;

private String presence;

private String health;

private String blockcount;

private String blocksize;

private String diskstate;

private String drivePowerPolicy;

private String expander1linkspeed;

private String expander2linkspeed;

private String fwUpdateOperState;

private String fwUpdateProgress;

private String ownership;

private String productId;

private String revision;

private String sasaddress1;

private String sasaddress2;

private String serial;

private String size;

private String vendor;

ConfigureHostNameConfig

private long configEntryId;

private long actionId;

private String netdevice;

private String vdcName;

private String hostName;

private boolean copyRunToStartConfig = true;

CreateSecurityDomainConfig

private long configEntryId;

private long actionId;

private String apicAccount;

private String securityDomain;

private String description;

CreateVRFConfig

Request

No Difference

Response

CustomActionRegistry.getInstance().registerDefinition( CustomActionRegistry.getInstance().registerDefinition( new WFTaskDefinition(WorkflowCategories. CATEGORY_CISCO_NETWORK_TASKS, CreateVRFConfig.HANDLER_NAME, CreateVRFConfig.HANDLER_LABEL, CreateVRFConfig.class, new CreateVRFHandler()) .withOutput(OP_DATACENTER).withOutput(OP_DEVICE_IP) .withOutput(OP_NET_DEVICE) .withOutput(OP_VRF).withOutput(OP_VRF_IDENTITY) .withOutput(OP_DOMAIN_NAME) ); CustomActionRegistry.getInstance().registerDefinition( new WFTaskDefinition(WorkflowCategories. CATEGORY_CISCO_NETWORK_TASKS, CreateVRFConfig.HANDLER_NAME, CreateVRFConfig.HANDLER_LABEL, CreateVRFConfig.class, new CreateVRFHandler()) .withOutput(OP_DATACENTER) .withOutput(OP_DEVICE_IP).withOutput(OP_NET_DEVICE) .withOutput(OP_VRF).withOutput(OP_VRF_IDENTITY) .withOutput(OP_DOMAIN_NAME) );

DeleteHostNameConfig

private long configEntryId;

private long actionId;

private String netdevice;

private String vdcName;

private String hostName;

private boolean copyRunToStartConfig = true;

DeleteMultipleVMConfig

private long actionId;

private long configEntryId;

private String vmId;

DeletePasswordResetConfig

private long configEntryId;

private long actionId;

private String userName;

DeleteSecurityDomainConfig

private long configEntryId;

private long actionId;

private String securityDomains;

DeleteVRFConfig

private long configEntryId;

private long actionId;

private String netdevice;

private String vdcName;

private String contextName;

private boolean copyRunToStartConfig;

DeviceHostEntry

private String datacenter;

private String deviceIp;

private String hostName;

private String context;

DeviceHostInfo

private String datacenter;

private String deviceIp;

private String vrfName;

private String defaultDomain;

private String nameServers;

private String context;

DeviceNTPConfiguration

private String datacenter;

private String deviceIp;

private String serverIP;

private String type;

private String context;

EMCXtremIOAttachTagConfig

private long configEntryId;

private long actionId;

private String accountIdentity;

private String resourceType;

private String volumeIdentity;

private String cgIdentity;

private String snapshotSetIdentity;

private String initiatorsGroupIdentity;

private String initiatorIdentity;

private String tagIdentity;

EMCXtremIOConsistencyGroupTagListReportPojo

private String accountName;

private String dcName;

private String cgName;

private String tagIndex;

private String tagName;

EMCXtremIOCreateTagConfig

private long configEntryId;

private long actionId;

private String accountIdentity;

private String name;

private String objectType;

private String nestTagUnder;

EMCXtremIODeleteTagConfig

private long configEntryId;

private long actionId;

private String tagIdentity;

EMCXtremIODetachTagConfig

private long configEntryId;

private long actionId;

private String accountIdentity;

private String resourceType;

private String volumeIdentity;

private String cgIdentity;

private String snapshotSetIdentity;

private String initiatorsGroupIdentity;

private String initiatorIdentity;

private String tagIdentity;

EMCXtremIOInitiatorGroupTagListReportPojo

private String accountName;

private String dcName;

private String initiatorGroupName;

private String tagIndex;

private String tagName;

EMCXtremIOInitiatorTagListReportPojo

private String accountName;

private String dcName;

private String initiatorName;

private String tagIndex;

private String tagName;

EMCXtremIORenameTagConfig

private long configEntryId;

private long actionId;

private String tagIdentity;

private String tagCaption;

EMCXtremIOScheduleTagListReportPojo

private String accountName;

private String dcName;

private String scheduleName;

private String tagIndex;

private String tagName;

EMCXtremIOSchedulerTagListReportPojo

private String accountName;

private String dcName;

private String scheduleName;

private String tagIndex;

private String tagName;

EMCXtremIOSnapshotSetTagListReportPojo

private String accountName;

private String dcName;

private String snapshotSetName;

private String tagIndex;

private String tagName;

EMCXtremIOTagObjectsReportPojo

private String accountName;

private String dcName;

private String objectType;

private String objectName;

private String caption;

private String objectIndex;

EMCXtremIOTagsReportPojo

private String accountName;

private String dcName;

private String name;

private String guid;

private String index;

private String caption;

private String objectType;

private List< List < String > > objectList;

EMCXtremIOVolumeTagListReportPojo

private String accountName;

private String dcName;

private String volumeName;

private String tagIndex;

private String tagName;

EMCXtremeIODisableSchedulersConfig

private long configEntryId;

private long actionId;

private String scheduleState;

private String schedulerIdentity;

EMCXtremeIOEnableSchedulersConfig

private long configEntryId;

private long actionId;

private String schedulerIdentity;

GetAPICSecurityRulesConfig

private long configEntryId;

private long actionId;

private String srcNetwork;

private String destNetwork;

HypervEditVMCloudConfig

private boolean assignVmToCloud=true;

private int vmId = -1;

private String cloud;

private long actionId;

private long configEntryId;

ModifyUserPasswordSecuredConfig

private String loginName;

private String currentLoginPassword;

private String newPassword;

private String confirmPassword;

private long actionId;

private long configEntryId;

PasswordResetConfig

private long configEntryId;

private long actionId;

private String netdevice;

private String userName;

private String password;

PushNTPConfigurationsConfig

Request

No Difference

Response

CustomActionRegistry.getInstance().registerDefinition( CustomActionRegistry.getInstance() .registerDefinition( new WFTaskDefinition (WorkflowCategories.CATEGORY_CISCO_NETWORK_TASKS, PushNTPConfigurationsConfig.HANDLER_NAME, PushNTPConfigurationsConfig.HANDLER_NAME, PushNTPConfigurationsConfig.class, new PushNTPConfigurationsHandler()) .withOutput(OP_DATACENTER) .withOutput(OP_DEVICE_IP).withOutput(OP_NET_DEVICE) .withOutput(OP_NTP_SERVER_IP) .withOutput(OP_NTP_STRATUM_NUMBER) .withOutput(OP_NTP_SERVER_IP_IDENTITY)); CustomActionRegistry.getInstance().registerDefinition( new WFTaskDefinition(WorkflowCategories. CATEGORY_CISCO_NETWORK_TASKS, PushNTPConfigurationsConfig.HANDLER_NAME, PushNTPConfigurationsConfig.HANDLER_NAME, PushNTPConfigurationsConfig.class, new PushNTPConfigurationsHandler()).withOutput(OP_DATACENTER) .withOutput(OP_DEVICE_IP).withOutput(OP_NET_DEVICE) .withOutput(OP_NTP_SERVER_IP) .withOutput(OP_NTP_STRATUM_NUMBER) .withOutput(OP_NTP_SERVER_IP_IDENTITY));

RemoveNTPConfigurationsConfig

private long configEntryId;

private long actionId;

private String ntpServerIP;

private boolean copyRunToStartConfig = true;

APIs with Newly Added Parameters

The following table provides the list of newly added parameters of XML REST APIs for Release 6.0 in comparison with Release 5.5.

API Name

Newly Added Parameters

AddBmaAccountConfig

private String sambaPassword;

private String reconfirmSambaPassword;

CIMCDiscoveredDevice

private String description ="N/A";

private String contact = "N/A";

private String location = "N/A";

private String rackGroup = "N/A";

private String tagPair;

CIMCServer

private String virtualMgmtIp;

private String dataModel;

private String serverId;

CIMCServerUtilizationHistory

private String apiDaysWithAccountName;

private String apiDaysWithServerIP;

CIMCStorageLocalDisk

private String controllerSerial;

CIMCStorageVirtualDrive

private String controllerSerial;

ConfigureAccessConfig

private String desc;

CreateVLANConfig

private boolean noShut = false;

DeleteHadoopClusterProfileConfig

private String clusterID;

private String tblflag;

DeviceModuleInfo

private String xBarID;

EMCXtremIOConsistencyGroupVolumesReportPojo

private List cgTagInfo;

EMCXtremeIOSchedulersReportPojo

private List< List < String > > tag_list;

private List scheduleTagInfo;

EMCXtremeIOSnapshotSetsReportPojo

private List< List < String > > tag_list;

private List snapSetTagInfo;

EMCXtremeIOVolumeReportPojo

private List< List < String > > tag_list;

private List volumeTagInfo;

EMCXtremeIoInitiatorGroup

private List< List < String > > tag_list;

private List initiatorGroupInfo;

HypervCreateIPPoolConfig

private String vipAddresses;

private String reservedAddresses;

HypervCreateIPPoolOnVMNetworkConfig

private String reservedAddresses;

IBMMdiskInfo

private String enclosure_id;

NetAppAssignClusterAggregateToUserGroupConfig

private boolean assignToUsers;

NetAppAssignClusterVolumeToUserGroupConfig

private boolean assignToUsers;

UcsNetworkControlPolicy

private String descr;

VDCCatalogItem

private boolean serviceRequestSupportEmailflag;

VPCDomainConfig

private String delayRestore;

private boolean peerGateway = false;

private boolean autoRecovery = false;

Internal API

The internal APIs are used in the custom task. This section provides the summary of changes applied to the methods of internal APIs for the current release.

Modified Methods

The following table provides the list of methods modified for internal APIs for Release 6.0 in comparison with Release 5.5.

Pojo Name

Method

com/cloupia/service/cIM/inframgr/AuthorizationPersistenceUtil.java

void addRoleActionMappings(List<UserRole> roles)=> void addRoleActionMappings()

com/cloupia/service/cIM/inframgr/resourceGroups/ ResourceGroupsUtil.java

String formatContainerNameForRollBack(String incomingContainerName, String dbContainerName)=> String formatContainerNameForRollBack(String dbContainerName, String tenantName)

com\cloupia\service\cIM\inframgr\LocaleUserManager.java

void addUserLocale(String username)=> void addUserLocale(String userName)

com/cloupia/service/cIM/tree/AccountListener.java

void validateAccount(InfraAccount Acc)=> void validateAccount(InfraAccount acc, boolean isCreateOperation)

com\cloupia\service\cIM\tree\VXLANPoolPolicyListner.java

void validavxLANRange(String vlanRange)=> void validavxLANRange(String vxlanRange)

Deleted Methods

The following table provides the list of methods deleted from internal APIs for Release 6.0 in comparison with Release 5.5.

Pojo Name

Deleted Methods

com/cloupia/service/cIM/inframgr/automation/ PlayTestRemoteInterface.java

List<String> getDBConnectionParams()

com/cloupia/service/cIM/inframgr/LdapInfraPersistenceUtil.java

UserAccessProfile getUapProfilesBasedOnGrp(String loginProfileName, int filteredGrpId, String groupName, String domainName)

com/cloupia/service/cIM/tree/VXLANPoolPolicyListner.java

boolean validateDCName(String dcName)

Java Reports

This section provides a list of Java reports to which columns are newly added for the current release.

Java Reports with New Columns

The following table provides the list of Java reports to which columns are newly added for Release 6.0 in comparison with Release 5.5.

Java Reports

Columns

GroupsCatalogTabularReport

- Menu ID

- Label

- Operation

- Path

- Filler Column

- Parent ID

DeviceHostsInfoTabularReport

- ID

- Pod

- Device IP

- VRF Name

- Default Domain

- Name Servers

DeviceModulesTabularReport

- XBar ID

DeviceNTPPeersTabularReport

- ID

- Pod

- Device IP

- NTP Server IP

- Server/Peer

DeviceVRFTabularReport

- ID

- Pod

- Device IP

- VRF

- VRF ID

- State

- Reason

EMCXtremIOInitiatorTagMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Initiator Name

- Tag Name

- Tag Index

EMCXtremIOSchedulerTagsMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Schedule Name

- Tag Name

- Tag Index

EMCXtremIOSnapshotSetTagMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Snapshot Set Name

- Tag Name

- Tag Index

EMCXtremIOSnapshotTagMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Volume Name

- Tag Name

EMCXtremIOTagTabularReport

- Unique ID

- DC Name

- Account Name

- Tag Name

- Caption

- GUID

EMCXtremIOTagsDrillDownInfoReport

- Unique ID

- DC Name

- Account Name

- Tag Name

- Volume Name

- Volume Index

- CG Name

- CG Index

- Snapshot Set Name

- Snapshot Set Index

- Initiator Group Name

- Initiator Group Index

- Scheduler Name

- Scheduler Index

- Object Name

- Object Index

EMCXtremIOTagsReport

- Unique ID

- DC Name

- Account Name

- Caption

- Name

- Index

- GUID

- ObjectType

EMCXtremIOVolumeTagMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Volume Name

- Tag Name

- Tag Index

EMCXtremeIOConsistencyGroupTagMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Consistency Group Name

- Tag Name

- Tag Index

EMCXtremeIOConsistencyGroupVolumesReport

- Tag Count

EMCXtremeIOInitiatorGroupInfoReport

- Tag Count

EMCXtremeIOInitiatorGroupTagMappingInfoReport

- Unique ID

- DC Name

- Account Name

- Initiator Group Name

- Tag Name

- Tag Index

EMCXtremeIOInitiatorsReport

- Tag Count

EMCXtremeIOSnapshotSetsReport

- Tag Count

EMCXtremeIOVolumeReport

- Tag Count

GroupServersListReport

- Association Status

HXNodeVersionSnapshotReport

- Host Name

- Host IP

- Hosts Version

HyperFlexAccountReport

- ID

- Account Name

- DC Name

- HX Cluster IP

- Server information

HyperFlexDatastorePopupReport

- ID

- Datstore Name

- Account Name

- DC Name

- Free Capacity

- Total Capacity

HyperFlexPodDatacenterAndClusterDiscoveryReport

- Property ID

- Label

- Requires License

- Description

- Filler Column

- Parent Property ID

- Additional Info

HyperFlexSRDetailsReport

- Entry ID

- Asset Label

- Service Request Id

- Asset Type

- Asset ID

- Change Description

- Change Type

HyperFlexVMsPerClusterReport

- Cloud Name

- VM-ID

- User Label

- VM Name

- Host Name

- IP Address

- Image Id

- Host Node

- Power Status

- Group Name

- Virtual Data Center

- Provisioned Time

- Scheduled Termination Time

- Last Status Update

- Guest OS Type

HyperflexClusterDrillDownEsxiHosts

- ID

- Pod

- AccountName

- Cluster UUID

- IP Address

- Address

- St Service

- Vlan Id

- GateWay

- SubnetMask

- Method

HyperflexClusterDrillDownInfo

- Unique ID

- Pod

- AccountName

- Name

- #Nodes

- Ddata Replication Factor

- Access Policy

- Workload Type

- vCenter Datacenter Name

- vCenter Cluster Name

- VCenterURL

- vCenter SSO URL

- VCenter Datacenter Mor

- VCenter Cluster Mor

HyperflexClusterDrillDownVMTemplates

- Cloud Name

- Image ID

- Image Name

HyperflexClusterInfoReport

- Unique ID

- Pod

- AccountName

- Cluster Name

- HX Cluster Name

- Datacenter Name

- Cluster UUID

- Status

- Health State

- Management IP

- Storage IP

- Raw Capacity(GB)

- Usable Capacity(GB)

- Used Capacity(GB)

- Free Capacity(GB)

- Provisioned

- Over Provisioned

- Replication Factor

- Resiliency Status

- Converged Nodes

- Nodes

- Policy Compliance

- Space Status

- Access Policy

- Reason

- Up Time

- Down Time

- Resiliency Details

HyperflexCompleteControllerNodeReport

- Unique ID

- Pod

- AccountName

- Cluster

- Host IP

- Host Name

- Controller VM Mor

- VM UUID

- Controller VM Name

- Management IP

- Storage IP

- Management VLAN ID

- Storage VLAN ID

- State

- Role

- Version

- Controller VM Host Name

- Controller VM Guest State

- Passthrough

- Host Status

HyperflexControlNodesReport

- Unique ID

- Pod

- AccountName

- Cluster UUID

- IP Address

- Address

- St Service

- Vlan Id

- Gateway

- SubnetMask

- Method

HyperflexDatastoreReport

- Unique ID

- ID

- Pod

- Account Name

- Datastore Name

- HX Datastore Name

- Datacenter Name

- Capacity(GB)

- Total Capacity(GB)

- Free Capacity(GB)

- Unshared Used Bytes

- UnCompressed Used Bytes

- System Datastore

- Mirrors

- Mount Status

- Accessible Status

- Hosts Mounted

- URL

- vCenter Datastore

- Datastore Mor

HyperflexDisksReport

- Unique ID

- Pod

- Cluster

- AccountName

- Host IP

- Slot

- Disk Name

- Path

- Disk Type

- Serial Number

- Raw Capacity(GB)

- Used Capacity(GB)

- State

- Status

- Usage

- Model

- Version

- Vendor

HyperflexEsxiDrillDown

- ID

- Account Name

- Cluster Name

- Host Name

- Memory Size (GB)

- CPU Description

- Hardware Model

- CPU Cores

- CPU Sockets

- CPU (GHz)

- Power Status

HyperflexVmsPodReport

- Cloud Name

- VM-ID

- User Label

- VM Name

- Host Name

- IP Address

- Image Id

- Host Node

- Power Status

- Group Name

- Guest OS Type

NxosDeviceHostNameTabularReport

- Identity

- Pod

- Device IP

- Host Name

PasswordResetUserNameTabularReport

- Identity

- Pod

- Device IP

- UserName

UcsSPVHBATabularReport

VCON

UcsSPVNICTabularReport

VCON

UnpubUcsChassisStorageVDScsiLunReportPerDC

- ID

- Account Name

- DN

- Lun Name

- Assigned To Server

- Profile Name

- Service Profile

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Click Here . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)