Cisco Cisco Prime Collaboration 10.5 User Guide

Page 35 of 78

Syntax:

public ResponseReturn syncDevice (CUPMServiceStub stub, DeviceValue device, SyncType syncType,

ExecuteOption executeOption, String endPointReference, String idPrefix);

Parameters:

• device—The device to synchronize; only the key attribute DeviceName is required. The Capability

attribute in the Device object can be used to specify which capacities to synchronize for devices that have

multiple capabilities.

• syncType—An Enum, indicating which of the two synchronizations to perform, or both. Values are INFRA,

SUBSCRIBER, BOTH (default).

• executeOption—An Enum, indicating whether to perform the synchronization or whether to return the

status summary of the last synchronization. Values are SYNC or LAST_SYNC_STATUS.

• endPointReference—String to convert to an EndpointReference object that the asynchronous result

notification will be sent to.

• idPrefix—String added to the beginning of a numeric string generated by the server that is set to the value

of the NBI ID. Null is allowed.

Returns:

CupmApiResponseValue—Object with NBI ID.

Throws:

SyncDeviceException—If server cannot execute NBI request.

ASyncReturn:

• CupmApiResultValue—Contains the CupmApiStatus and an CupmApiList. The CupmApiList contains one

or two CupmApiList objects, each in the synchronization status format. When two are present, the first is

for Infrastructure synchronization status, and the second is for Subscriber synchronization status.

• CupmApiFaultType—Included if the NBI request fails.

syncDomain Java Signature

Performs a Prime Collaboration Provisioning synchronization of a Domain with its devices.

Syntax:

public ResponseReturn syncDomain (CUPMServiceStub stub, DomainValue Domain, ExecuteOption

executeOption, String endPointReference, String idPrefix);

Parameters:

• Domain—The key attribute, DomainID is required.