Bulk Operation API

Operations

• create: Update IP address or hostnames, rebuild (if chosen) VMs in the inventory, perform full synchronization, and complete the upgrade using the URL:

  https://<server>:<serverport>/unifiedconfig/config/machineinventory/bulkoperation

• get: Returns a list of machines in the CSV format based on the response parameters, using the URL:

  https://<server>/unifiedconfig/config/machineinventory/bulkoperation/template? datacenter=<sitename>&category=<category>&<peripheralSet=<peripheralSet name>

Response Parameters for get

• datacenter: The name of the datacenter. For example: Main. This field is case-sensitive. Use Main to refer to Main site in 4000 and 12000 Agent deployments and Core to refer to Main site in 2000 Agent deployments.

• category: The machine category. Supported values are core, optional, or peripheral.

• peripheralSet: The name of the peripheral set. This parameter is mandatory only for Packaged CCE 4000 or 12000 Agent deployments, if the category is PERIPHERAL.

Payload for Create

Payload for Inventory Update:

• name: The name of the inventory file. For example: main_updateinventory.csv.

• operation: The type of operation. Supported value is:

  UPDATE: updates the inventory with as per the content of the inventory file.

• content: The content of the inventory file.

  For more information on the Inventory file details, see the Cisco Packaged Contact Center Enterprise Administration and Configuration Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/packaged-contact-center-enterprise/products-maintenance-guides-list.html.

Example Create Request for 4000 and 12000 Agent Deployments

Copy
<inventoryUpdateFile>
    <name>main_ps1_peripheral_inventory.csv</name>
    <operation>UPDATE</operation>
    <datacenter>Main</datacenter>
    <category>peripheral</category>
    <content>
	name,machineType,publicAddress,privateAddress,side,newPublicAddress,newPrivateAddress,connectionInfo,isReinstalled
	TR1-PG1A,CCE_PG,10.10.10.26,10.10.20.26,sideA,10.10.10.26,10.10.20.26,,Yes
	TR1-PG1B,CCE_PG,10.10.10.27,10.10.20.27,sideB,10.10.10.27,10.10.20.27,,Yes
    </content>
    <peripheralSetName>ps1</peripheralSetName>
</inventoryUpdateFile>

Example Create Response for 4000 and 12000 Agent Deployments

Copy
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <state>SUCCEEDED</state>
    <statuses>
        <status>
            <state>SUCCEEDED</state>
            <name>LoggerUpdateTask_sideA</name>
        </status>
        <status>
            <state>SUCCEEDED</state>
            <name>LoggerUpdateTask_sideB</name>
        </status>
        <status>
            <state>SUCCEEDED</state>
            <name>RouterUpdateTask_sideA</name>
        </status>
        <status>
            <state>SUCCEEDED</state>
            <name>RouterUpdateTask_sideB</name>
        </status>
        <status>
            <state>SUCCEEDED</state>
            <name>AwUpdateTask</name>
        </status>
        <status>
            <state>SUCCEEDED</state>
            <name>InventoryDBUpdateTask</name>
        </status>
    </statuses>
</results>