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_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 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_ECE |
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. Valid characters are period (.), hyphen (-), underscore (_), and alphanumeric. The first character must be alphanumeric. Maximum length is 128 characters.
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.
hostName: The host name of the machine.
If you provide a hostname, a lookup is performed to find the FQDN for that host. If the FQDN is found, the hostName field is then set to that FQDN value and the Machine Address is set to the IP address corresponding to the hostname.
If you do not provide a hostname, a lookup is performed using the address field in the API request. If the FQDN is found, the hostName field is set to that FQDN value.
networks: A collection of network parameters. See the network parameters below.
vmInstanceUuid: A unique identifier for the virtual machine.
Network parameters:
type: Public or private. Private networks are only specified for CCE_PG and CCE_ROGGER.
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.
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: For CCE and Unified CVP, this is the Diagnostic Portal API. For Finesse and Unified Intelligence Center, this is the SOAP API. Required for CCE_AW 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.
ADMINISTRATION: Connection information for administrative access. Required for CVP OAMP.
SM_REST_API: SocialMiner REST API.
CONTEXT_SERVICE: Contains the last-written Context Service connection data.
IDS: Indicates an Identity Server service. IDS contains the following parameters:
IDS_PRIMARY_REF: When present, the <uri> parameter for this service refers to the primary Identity Server (IdS) to which this component is associated.
IDS_SECONDARY_REF: Read only. The <uri> parameter for this service refers to the backup IdS to which this component is associated. For a create or update request, this field is automatically filled with the refURL of the secondary IdS (if present).
The following table shows the parameters that are searched and the parameters that are sortable.
Advanced search parameters
serviceType:<service type>: Returns only machines associated with the specified service type. For example, serviceType:IDS_PRIMARY_REF returns only SSO-capable machines.
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>
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>
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>