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.
create: Creates a machine by updating the database. See table below for restrictions per machine type. Create is allowed for external machines types only.
delete: Removes one machine.
get: Returns one machine and all associated addresses and services based on machine ID, using the URL https://<server>/unifiedconfig/config/machineinventory/<id>.
status: Returns any alerts indicating errors in the state of the inventory, using the URL https://<server>/unifiedconfig/config/machineinventory/status.
list: Retrieves a list of all machines in the inventory. See table below for more details.
update: Updates one machine.
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 |
Machine parameters:
refURL: The refURL of the machine. See Shared Parameters.
name: External name of the machine. For example, the VM host name. See Shared Parameters.
changeStamp: See Shared Parameters.
type: The type of machine.
versionInfo: Version info available depending on product type. Includes the following parameters (by product type):
vmhost: A reference to a machine of type VM_HOST, including refURL and name. See References.
autogenerated: Indicates if the information was generated automatically.
networks: A collection of network parameters. See the network parameters below.
Network parameters:
type: Public or private. Private networks are only specified for CCE_CALL_SERVER and CCE_DATA_SERVER.
address: The IP address. Must be valid hostname, IPV4, or IPV6 address.
services: A collection of service parameters. See the services parameters below.
Services parameters:
uri: The service URL, for example, Diagnostic Portal URL or management console link.
port: The port for this service.
username: The username used to access the service. Username maximum is 128 characters.
password: The password used to access the service. The password can be used when creating or updating, but is not returned.
enablePassword: Used for gateways.
description: The description of the service. See Shared Parameters.
pairing: Indicates if services on different machines are related. Related services have a matching value.
vmInstanceUuid: A unique identifier for the virtual machine.
type: The service type. Values for type are as follows:
ESXI: VM Host running ESXi server for connection to interrogate for VMs.
AXL: AXL connection information for Unified CM. Required for UCM Publisher.
DIAGNOSTIC_PORTAL: Diagnostic Portal API. Required for Data Server on side A, CVP OAMP, FINESSE on side A, and CUIC Publisher.
GATEWAY: Connection information for gateways.
MANAGEMENT_LINK: Provides a URL of the management console for the machine.
TIP_PG: LiveData connection information for peripheral gateways.
TIP_ROUTER: LiveData connection information for the router.
The following table shows the parameters that are searched and the parameters that are sortable.
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>