Machine Inventory API

This API returns the machines in the solution. Machines include VMs, VM Hosts, external machines, and gateways.

For information on how to perform a machine inventory scan, see Scan API.

URL

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

Operations

Type Create / Update / Delete operations allowed Number allowed

VM_HOST

No

1 Side A

1 Side B

CCE_ROGGER

No

1 Side A

1 Side B

CCE_PG

No

1 Side A

1 Side B

CCE_AW

Side A: Update only

Side B: No

1 Side A

1 Side B

CVP

No

1 Side A

1 Side B

CM

Update only

0 - Must be changed after initial scan.

CM_PUBLISHER

Update only

1 Side A, 0 Side B for on box CM Deployments

0 for off box CM deployments

CM_SUBSCRIBER

Update only

1 Side A, 1 Side B for on box CM Deployments

0 for off box CM deployments

CVP_REPORTING

No

0 - 1 Side A

CUIC_PUBLISHER

Update only

1 Side A

CUIC_SUBSCRIBER

No

1 Side B

CVP_OPS

Update only

1 Side A

FINESSE

Side A: Update only

Side B: No

1 Side A

1 Side B

0 - 1 Side B

ECE

No

CVVB

(Cisco Virtualized Voice Browser)

No

0 - 8

GATEWAY

No

0 - 8

EXTERNAL_SOCIAL_MINER

All

0 - 1

EXTERNAL_CM_PUBLISHER

All

0 - 10 for on box CM deployments

1 - 11 for off box CM deployments

EXTERNAL_CM_SUBSCRIBER

No

External subscribers cannot be created, updated, or deleted as this automatically occurs when the external publisher is created, updated, or deleted.

EXTERNAL_CVP_REPORTING

All

0 - 1

EXTERNAL_HDS

Update only

0 - 2

EXTERNAL_MEDIA_SENSE

All

0 - 1

EXTERNAL_ECE

All

0 - 1

EXTERNAL_THIRD_PARTY _MULTICHANNEL

All

0 - 1

DATA_CENTER

No create, update, or delete

0 - 10

DC_CCE_PG

No create, update, or delete

0 - 20

DC_CVP

No create, update, or delete

0 - 20

DC_FINESSE_PRIMARY

Update only

0 - 10

DC_FINESSE_SECONDARY

No create, update, or delete

0 - 10

Parameters

Machine parameters:

Network parameters:

Services parameters:

Search and Sort Values

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters Sort parameters
  • name
  • description
  • hostName
  • name (default)

  • description

  • hostName

See Search and Sort.

Advanced search parameters

You can perform a machine type search or a service type search on the Machine Inventory API:
  • types: (machine_type1 | machine_type2 | machine_type3...): Returns all the machines of the specified type. For example, types:(VM_HOST | EXTERNAL_SOCIAL_MINER | PUB_SUBSCRIBER) returns all the machines that belong to any of the specified machine types. The machine type is case-insensitive.

  • datacenters: (dc1|dc2|dc3...): Returns machines which belong to any of the specified data center. The data center names are fully matched (case-insensitive, no partial matches). Searching for "core" returns all machines in the core data center.

  • serviceType:<service type>: Returns only machines associated with the specified service type. For example, serviceType:IDS_PRIMARY_REF returns only SSO-capable machines.

Example Inventory Status Response

https://<server>/unifiedconfig/config/machineinventory/status

<status>
   <alerts>
      <alert>
         <apiErrors>
            <apiError>
               <errorData>CM_PUBLISHER</errorData>
               <errorMessage>CM_PUBLISHER not found on vmhost sideA</errorMessage>
               <errorType>inventory.MissingMachine</errorType>
            </apiError>
         </apiErrors>
         <machine>
            <host>sideA</host>
            <type>CM_PUBLISHER</type>
         </machine>      
      </alert>
   </alerts>
   <scanInfo>
      <lastScanDateTime>1374842924017</lastScanDateTime>
      <scanState>Idle</scanState>
   </scanInfo>
</status>

Example Get Response

https://<server>/unifiedconfig/config/machineinventory/<id>

<machine>
    <changeStamp>4</changeStamp>
    <refURL>/unifiedconfig/config/machineinventory/12073</refURL>
    <networks>
        <network>
            <address>10.10.10.21</address>
            <services>
                <service>
                    <autoGenerated>false</autoGenerated>
                    <port>7890</port>
                    <type>DIAGNOSTIC_PORTAL</type>
                    <userName>user@domain</userName>
                </service>
            </services>
            <type>PUBLIC</type>
        </network>
    </networks>
    <autoGenerated>false</autoGenerated>
    <hostName>CCE-AW-1-21</hostName>
    <type>CCE_AW</type>
    <versionInfo>
        <buildNumber>03297</buildNumber>
        <version>11.0(1)</version>
    </versionInfo>
    <name>WJ2-AW-1</name>
    <vmHost>
        <refURL>/unifiedconfig/config/machineinventory/12071</refURL>
        <name>sideA</name>
    </vmHost>
    <vmInstanceUuid>50290e07-fa3d-2667-b84b-1c35989000e2</vmInstanceUuid>
</machine>

Example Updating SSO-Capable Components Associated to an IdS

SSO-capable components can be associated to an IdS with the <components> element. For example, a PUT request like this will update the IDS_PRIMARY_REF and IDS_SECONDARY_REF of any SSO-capable components. Note that refURLs of any on-box PCCE machines will be ignored as these cannot be changed. An example of an off-box PCCE machine is the EXTERNAL_HDS machine.

This operation will also de-associate any existing component references to that IdS that aren’t in the list. For example, if there were three components associated to this IdS before the operation, only two components would be associated after the operation was complete.

<machine>
    <changeStamp>1</changeStamp>
    <refURL>/unifiedconfig/config/machineinventory/5000</refURL>
    <networks>
        <network>
            <type>PUBLIC</type>
            <address>10.10.10.22</address>
            <services>
                <service>
                    <type>IDS</type>
                    <components>
                        <component>
                            <refURL>/unifiedconfig/config/machineinventory/6000</refURL>
                        </component>
                        <component>
                            <refURL>/unifiedconfig/config/machineinventory/6001</refURL>
                        </component>
                    </components>
                </service>
            </services>
        </network>
    </networks>
</machine>