URL

Operations

• create: Creates a machine by updating the database. See the following table for restrictions per machine type.

• delete: Removes one machine.

• get: Returns one machine and all associated addresses and services based on the machine ID, using the URL https://<server>/unifiedconfig/config/machineinventory/<id>.

• list: Retrieves a list of all machines in the inventory. See the following table for more details.

• update: Updates one machine.

Parameters

Machine parameters:

• refURL: The refURL of the machine. See Shared Parameters.

• name: External name of the machine. For example, the VM hostname. See Shared Parameters.

• changeStamp: See Shared Parameters.

• type: The type of machine.

• autogenerated: Indicates if the information was generated automatically.

• hostName: The hostname 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 section.

Network parameters:

• type: Must be public.

• address: The IP address. Must be valid hostname, IPv4, or IPv6 address.

• services: A collection of service parameters. See the Services Parameters section.

Services parameters:

• 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.

• description: The description of the service. See Shared Parameters.

• pairing: Indicates if services on different machines are related. Related services have a matching value.

  For the service type PRINCIPAL_AW, the pairing value is "false" for all AWs.

• type: The service type. Values for type are as follows:

  • LIVE_DATA_API: Connection information for the Live Data Rest API. Requires a username and password.

  • LIVE_DATA_CASSANDRA: Connection information for the Live Data Cassandra database.

  • LIVE_DATA_WEB_SOCKETS: Connection information for the Live Data Socket.IO service.

  • TIP_PG: LiveData connection information for peripheral gateways.

  • TIP_ROUTER: LiveData connection information for the router.

  • TIP_PG_TOS: LiveData test-other-side connection information for peripheral gateways.

  • TIP_ROUTER_TOS: LiveData test-other-side connection information for the router.

  • ACTIVE_MQ: LiveData Active MQ connection information.

  • STORM_DRPC: LiveData Storm DRPC connection information.

  • AW_REST_API: Administration & Data Server (AW) Rest API

  • CLOUD_CONNECT_CREDINITIALS: Credinitial information for Cloud Connect Services.

Search and Sort Values

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

See Search and Sort.

Example Update Request

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

<machine>
  <name>myLiveDataMachine</name>
  <hostName>liveDataHostName</hostName>
  <type>LIVE_DATA</type>
  <networks>
    <network>
      <type>PUBLIC</type>
      <address>1.2.3.4</address>
      <services>
        <service>
          <type>ACTIVE_MQ</type>
          <port>61616</port>
          <pairing>1</pairing>
        </service>
        <service>
          <type>STORM_DRPC</type>
          <port>3772</port>
          <pairing>1</pairing>
        </service>
        <service>
          <type>LIVE_DATA_WEB_SOCKETS</type>
          <port>12008</port>
          <pairing>1</pairing>
        </service>
        <service>
          <type>LIVE_DATA_API</type>
          <port>12005</port>
          <pairing>1</pairing>
          <userName>user</userName>
          <password>password</password>
        </service>
        <service>
          <type>LIVE_DATA_CASSANDRA</type>
          <port>12000</port>
          <pairing>1</pairing>
        </service>
      </services>
    </network>
  </networks>
</machine>

Example Get Response

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

<machine>
  <changeStamp>3</changeStamp>
  <refURL>/unifiedconfig/config/machineinventory/5000</refURL>
  <networks>
    <network>
      <address>1.2.3.4</address>
      <services>
        <service>
          <autoGenerated>true</autoGenerated>
          <pairing>0</pairing>
          <port>40034</port>
          <type>TIP_ROUTER</type>
        </service>
        <service>
          <autoGenerated>true</autoGenerated>
          <pairing>0</pairing>
          <port>40035</port>
          <type>TIP_ROUTER_TOS</type>
        </service>
      </services>
      <type>PUBLIC</type>
    </network>
  </networks>
  <autoGenerated>true</autoGenerated>
  <hostName>routerA</hostName>
  <type>CCE_ROUTER</type>
  <name>routerA</name>
</machine>