SysInv API v1
Manage physical servers with the Titanium System Inventory API. This includes
inventory collection and configuration of nodes, ports, interfaces, CPUs, disks,
partitions, memory, and sensors. The API also supports configuration of the
cloud's SNMP interface.
The typical port used for the SysInv REST API is 6385.
However, proper technique would be to look up the sysinv service endpoint in Keystone.
System
The cloud server cluster is represented internally by a unique object referred to as the
system.
Clusters
A cluster within the cloud server is represented internally by a unique object referred to as the
cluster.
Hosts
Hosts are the physical hosts or servers for the system.
Ports
These APIs allow the display of the physical ports of
a host and their attributes.
Interfaces
These APIs allow the create, display, modify and delete
of the L2 interfaces of a host.
CPUs
These APIs allow the display of the logical core(s) of the
processor(s) on a host, and the display and modification
of the cores assigned function.
Memory
These APIs allow the display of the size and usage
of various memory areas of the NUMA nodes of a host.
The modification of the size of these memory areas is
also supported through these APIs.
The different memory areas of a NUMA node of a host are:
Memory reserved for the Platform; where the Platform consists
of the kernel and the cloud services,
Memory reserved for the virtual switch (Note: only on 'compute' hosts),
Memory reserved for the hosted VMs (Note: only on 'compute' hosts).
SensorGroup
These APIs allow the display of the operational state
and configuration attributes of the sensorgroups of a host.
The modification of certain sensorgroup attributes is
supported through these APIs; and propagates the
configuration change to the corresponding attributes of
all sensors defined in the group.
Examples of sensorgroup sensortype monitoring for
the host are:
temperature,
voltage,
current,
fan,
cpu,
memory,
disk,
partition,
firmware baseline,
hardware baseline.
Sensor
These APIs allow the display of the status and
operational state of various sensor areas of a host.
The modification of the certain sensor attributes is
also supported through these APIs.
Examples of different sensortypes are as defined for
the sensorgroup.
Volume Groups
These APIs allow the creation, deletion, and displaying
of LVM volume groups.
Physical Volumes
These APIs allow the creation, deletion, and displaying
of LVM physical volumes.
Profiles
These APIs allow the create, display and delete
of host profiles. This includes interface profiles,
cpu profiles, and volume profiles. NOTE that the
same record is used in the database for both hosts and
host profiles.
DNS
The DNS is the Domain Name Server entity for the system.
NTP
The NTP is the Network Time Protocol entity for the system.
External OAM
The extoam is the External OAM entity for the system.
Infrastructure Subnet
The infra is the Infrastructure subnet entity for the system.
DRBD Configuration
The drbdconfig is the Distributed Replicated Block Device (DRBD)
configuration entity for the system.
Devices
These APIs allow the display of the pci devices of
a host and their attributes.
LLDP Agents
These APIs allow the display of the lldp agents of
a host and their attributes.
LLDP Neighbors
These APIs allow the display of the lldp neighbors of
a host and their attributes.
Services
These APIs allow the display of the services running
and their attributes
Service Nodes
These APIs allow the display of the service nodes
and their attributes
Service Groups
These APIs allow the display of the service groups
and their attributes
SDN Controllers
These APIs allow for the display and configuration of
the SDN controllers that each of the compute nodes will connect
to for the purpose of SDN manager interface (i.e. OVSDB connection).
The SDN controllers configured are for active connections to
the SDN controller for each of the virtual switch instances running
on the compute nodes, and is shared across all compute nodes.
Remote Logging
These APIs allow the display and configuration of the
remote logging settings
Networks
These APIs allow the display of system managed networks. They are intended for internal system use only.
Address Pools
These APIs allow the display and configuration of IP address pools.
Addresses
These APIs allow the display and configuration of IP addresses for a specific host resource.
Routes
These APIs allow the display and configuration of IP route for a specific host resource.
Storage Backends
These APIs allow the display and configuration of different storage backends.
Storage Tiers
These APIs allow the create, display, modify and delete
of the storage tiers.
Controller Filesystem
These APIs allow the display and configuration of the controller filesystem.
Ceph Monitors
These APIs allow the display and configuration of the Ceph monitors.
System Health
These APIs allow the display of the system health.
Software Loads
These APIs allow the display and configuration of the software loads.
Software Upgrade
These APIs allow the display and configuration of the software upgrade.
System Certificate Configuration
These APIs allow for the display and configuration of
Host certificates which include SSL, Murano and Trusted Platform Module(TPM) certificates.
Custom Firewall Rules
These APIs allow for the installation of custom firewall rules.
License
These APIs allow for the installation of license file and display of
the license information.