Home
Log
Application
Auditlog
Category
Certificate
Cloud_Profile
Container_Registry
Data_Pipeline
Data_Source
Event
Function
Helm
Auth
Application_Status
LogCollector
ML_Model
MLModel_Status
Node
Node_Info
Project
Runtime_Environment
Service_Domain
Service_Domain_Info
Project_Service
SSH
User_API_Token
User_Public_Key
Powered by Stoplight

Introduction

The Nutanix Xi IoT application programming interface (API) enables you to simplify edge computing and cloud infrastructure management.

Nutanix Xi IoT provides a fully managed edge-computing platform to build and deploy applications at planet scale. It provides a full software stack consisting of managed platform services such as Containers, Function, AI inferencing, and data services like in-memory Pub-Sub Kafka, all as a service.

You can use the Xi IoT platform to manage your edge computing infrastructure and the life cycle of applications running on it.

Xi IoT provides a rich set of APIs to accomplish these key goals. Infrastructure administrators can automate a variety of tasks (like creating and updating edges, managing physical infrastructure resources and role based access control). Developers can use APIs to integrate Xi IoT with their CI/CD pipelines, and deploy applications, functions and data pipelines.

Terminology

Category

Logically grouped service domain, data sources, and other items. Applying a category to an entity applies any values and attributes associated with the category to the entity.

Cloud Connector

Built-in Xi IoT platform feature to publish data to a public cloud like Amazon Web Services or Google Cloud Platform. Requires a customer-owned secured public cloud account and configuration in the Xi IoT management console.

Cloud Profile

Cloud provider service account (Amazon Web Services, Google Cloud Platform, and so on) where acquired data is transmitted for further processing.

Container Registry Profile

Credentials and location of the Docker container registry hosted on a cloud provider service account. Can also be an existing cloud profile.

Data Pipeline

Path for data that includes input, processing, and output blocks. Enables you to process and transform captured data for further consumption or processing.

  • Input. An existing data stream or data source, identified according to a Category

  • Transformation. Code block such as a script defined in a Function to process or transform input data.

  • Output. A destination for your data. Publish data to the cloud or cloud data service (such as AWS Simple Queue Service) at the edge.

Data Service

Cloud hosted data infrastructure such as AWS Simple Queue Service or Google Pub/Sub.

Data Source

A collection of sensors, gateways, or other input devices to associate with a node or service domain. Enables you to manage and monitor sensor integration and connectivity.

Node (previously known as Edge Device)

Any location (hospital, parking lot, retail store, oil rig, factory floor, and so on) where sensors or other input devices are installed and collecting data. Typical sensors measure (temperature, pressure, audio, and so on) or stream (for example, an IP-connected video camera). A node minimally consists of a node (also known as edge device) and a data source.

Functions

Code used to perform one or more tasks. A script can be as simple as text processing code or it could be advanced code implementing artificial intelligence, using popular machine learning frameworks like Tensorflow.

Infrastructure Administrator

User who creates and administers most aspects of Xi IoT. The infrastructure administrator provisions physical resources, service domains, data sources and public cloud profiles. This administrator allocates these resources by creating projects and assigning project users to them.

Project

A collection of infrastructure (service domain, data source, project users) plus code and data (applications, data pipelines, functions, run-time environments), created by the infrastructure administrator for use by project users.

Project User

User who views and uses projects created by the infrastructure administrator. This user can view everything that an infrastructure administrator assigns to a project. Project users can utilize physical resources, as well as deploy and monitor data pipelines and applications. This user has project-specific CRUD permissions: the project user can create, read, update, and delete assigned applications, scripts, data pipelines, and other project users.

Real-time Data Stream

  1. Data Pipeline output endpoint type with a service domain as an existing destination.

  2. An existing data pipeline real-time data stream that is used as the input to another data pipeline.

Run-time Environment

A run-time environment is a command execution environment to run applications written in a particular language or associated with a Docker registry or file.

Service Domain

Intelligent Platform as a Service (PaaS) providing the Xi IoT service domain infrastructure (consisting of a full software stack combined with a hardware device). It enables customers to deploy intelligent applications (powered by AI/artificial intelligence) to process and transform data ingested by sensors. This data can be published selectively to public clouds.

Xi IoT Management Console

Browser-based console where you can manage the Xi Iot platform and related infrastructure, depending on your role (infrastructure administrator or project user).

Xi IoT

Software as a Service (SaaS)/Platform as a Service (PaaS) based management platform and cloud IoT services. Includes the Xi IoT management console.