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_CALL_SERVER

No

1 Side A

1 Side B

CCE_DATA_SERVER

Side A: Update only

Side B: No

1 Side A

1 Side B

CVP

No

2 Side A

2 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

GATEWAY

No

None

EXTERNAL_SOCIAL_MINER

All

0 - 1

EXTERNAL_CM_PUBLISHER

All

0 for on box CM deployments

1 for off box CM Deployments

EXTERNAL_CM_SUBSCRIBER

No

Not allowed for on box CM Deployments

A minimum of 2 for off box CM Deployments. 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_EIM_WIM

All

0 - 1

EXTERNAL_THIRD_PARTY _MULTICHANNEL

All

0 - 1

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
  • name (default)
  • description

See Search and Sort.

Example Response

Inventory status: 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>

<machines>  
   <changeStamp>6</changeStamp>
   <refURL>/unifiedconfig/config/machineinventory/8241</refURL>
   <networks>
     <network>
       <address>10.10.10.81</address>
       <services>
         <service>
           <autoGenerated>true</autoGenerated>
           <port>23</port>
           <type>GATEWAY</type>
           <userName>admin</userName>
         </service>
       </services>
      <type>PUBLIC</type>
     </network>
   </networks>
     <autoGenerated>true</autoGenerated>
     <description>Gateway discovered from CVP Diagnostic Portal</description>
     <type>GATEWAY</type>
     <versionInfo>
       <version>15.1(4)M3</version>
     </versionInfo>
     <name>GATEWAY_10.10.10.81</name>
  </machine>
  <machine>
    <changeStamp>2</changeStamp>
    <refURL>/unifiedconfig/config/machineinventory/8899</refURL>
    <networks>
      <network>
       <address>10.10.10.82</address>
       <services>
         <service>
           <autoGenerated>true</autoGenerated>
           <port>23</port>
           <type>GATEWAY</type>
           <userName>admin</userName>
         </service>
       </services>
      <type>PUBLIC</type>
     </network>
    </networks>
     <autoGenerated>true</autoGenerated>
     <description>Gateway discovered from CVP Diagnostic Portal</description>
     <type>GATEWAY</type>
     <name>GATEWAY_10.10.10.82</name>
   </machine>
</machine>