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.
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 |
No |
1 Side A |
CUIC_SUBSCRIBER |
No |
1 Side B |
CVP_OPS |
Update only |
1 Side A |
FINESSE |
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 |
Machine parameters:
Network parameters:
Services parameters:
The following table shows the parameters that are searched and the parameters that are sortable.
Inventory status: https://<server>:<serverport>/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>:<serverport>/unifiedconfig/config/machineinventory/<id>
<machine> <changeStamp>6</changeStamp> <refURL>/unifiedconfig/config/machineinventory/8241</refURL> <networks> <network> <address>10.10.10.20</address> <services> <service> <autoGenerated>true</autoGenerated> <description>LiveData Event service for PG</description> <pairing>5000</pairing> <port>42034</port> <type>TIP_PG</type> </service> <service> <autoGenerated>true</autoGenerated> <description>LiveData Event service for Router</description> <pairing>0</pairing> <port>40034</port> <type>TIP_ROUTER</type> </service> <service> <autoGenerated>true</autoGenerated> <description>LiveData Event service for PG TOS</description> <pairing>5000</pairing> <port>42035</port> <type>TIP_PG_TOS</type> </service> <service> <autoGenerated>true</autoGenerated> <description>LiveData Event service for Router TOS</description> <pairing>0</pairing> <port>40035</port> <type>TIP_ROUTER_TOS</type> </service> </services> <type>PUBLIC</type> </network> <network> <address>10.1.1.20</address> <type>PRIVATE</type> </network> </networks> <autoGenerated>true</autoGenerated> <hostName>CCE-CS-A-20.berlin.icm</hostName> <type>CCE_CALL_SERVER</type> <name>testCallServerA</name> <vmHost> <refURL>/unifiedconfig/config/machineinventory/8238</refURL> <name>sideA</name> </vmHost> <vmInstanceUuid>5006174b-e4fd-3d33-6cca-8855edebf3f8</vmInstanceUuid> </machine>