Resources
 Uyuni Project  Report Issue  Contribute
Language
 English  한국어  日本語  中国人

Uyuni

    • License
    • Quick Start
      • Install Uyuni Server
      • Install Uyuni Proxy
    • Installation/Upgrade Guide
      • Requirements
        • Network Requirements
          • Required Network Ports
        • Client Requirements
        • Public Cloud Requirements
      • Installation
        • Uyuni Server
          • Install Uyuni Server with openSUSE
          • Install on Public Cloud
        • Uyuni Proxy
          • Install Uyuni Proxy with openSUSE
          • Install Containerized Proxy
          • Install on K3s
      • Setup
        • Uyuni Server
          • Uyuni Server Setup
          • Setup Wizard
          • Web Interface Setup
          • Public Cloud Setup
          • Connect Pay-as-you-go instance
        • Uyuni Proxy
          • Uyuni Proxy Registration
          • Uyuni Proxy Setup
          • Containerized Proxy Setup
      • Upgrade
        • Upgrade the Server
          • Server - Minor Upgrade
          • Server - Major Upgrade
        • Upgrade the Proxy
          • Proxy - Major Upgrade
          • Proxy - Minor Upgrade
        • Upgrade the Database
          • Database Migration to Latest Version
        • Upgrade the Clients
    • Client Configuration Guide
      • Supported Clients and Features
        • SLES Supported Features
        • SLE Micro Supported Features
        • Alibaba Cloud Linux Supported Features
        • AlmaLinux Supported Features
        • Amazon Linux Supported Features
        • CentOS Supported Features
        • Debian Supported Features
        • Oracle Supported Features
        • Red Hat Supported Features
        • Rocky Linux Supported Features
        • Ubuntu Supported Features
      • Configuration Basics
        • Software Channels
          • Software Repositories
          • Software Products
        • Bootstrap Repository
        • Activation Keys
        • GPG Keys
      • Client Management Methods
        • Managing Salt Clients
          • Push via Salt SSH
          • Salt Bundle
        • Managing Traditional Clients
          • rhnsd
            • OSAD
          • Push via SSH
      • Client Registration
        • Registration Methods
          • Register with the Web UI
          • Register with Bootstrap Script
          • Register on the Command Line
        • SUSE Client Registration
          • SUSE Linux Enterprise Clients
          • SLE Micro Clients
        • openSUSE Client Registration
          • openSUSE Leap Clients
          • openSUSE MicroOS
        • Alibaba Cloud Linux Client Registration
          • Alibaba Cloud Linux Clients
        • AlmaLinux Client Registration
          • AlmaLinux Clients
        • Amazon Linux Client Registration
          • Amazon Linux Clients
        • CentOS Client Registration
          • CentOS Clients
        • Debian Client Registration
          • Debian Clients
        • Oracle Client Registration
          • Oracle Clients
        • Red Hat Client Registration
          • Red Hat Clients - CDN
          • Red Hat Clients - RHUI
        • Rocky Linux Client Registration
          • Rocky Linux Clients
        • Ubuntu Client Registration
          • Ubuntu 20.04 and 22.04 Clients
          • Ubuntu 18.04 Clients
        • Client Registration to a Proxy
          • Register to a Proxy with the Web UI
          • Register to a Proxy with CLI
          • Register to a Proxy with a Script
        • Public Cloud Clients
          • Automatic Registration of Clients Created by Terraform
      • Client Upgrades
        • Major Version Upgrade
        • With Content Lifecycle Manager
        • Product Migration
        • openSUSE Leap Minor Version Upgrade
      • Client Deletion
      • Client Operations
        • Package Management
        • Patch Management
        • System Locking
        • Configuration Management
        • Power Management
        • Configuration Snapshots
        • Custom System Information
        • System Set Manager
        • System Groups
        • System Types
      • Operating System Installation
        • Reinstall Registered Systems
        • Install via the Network (PXE Boot)
        • Install via a CD-ROM or a USB Key
        • Autoinstallable Distributions
        • Autoinstallation Profiles
        • Unattended Provisioning
        • Use Your Own GPG Key
      • Virtualization
        • Virtualization with Xen and KVM
      • Virtual Host Managers
        • VHM and AWS
        • VHM and Azure
        • VHM and GCE
        • VHM and Kubernetes
        • VHM and Nutanix
        • VHM and VMWare
        • VHM with Other Hosts
    • Administration Guide
      • Actions
      • Authentication Methods
        • Authentication With SSO
        • Authentication With PAM
      • Backing Up and Restoring
      • Content Staging
      • Channel Management
        • Custom Channels
      • Content Lifecycle Management
        • Content Lifecycle Management Examples
      • Disconnected Setup
      • Disk Space Management
      • Image Management
      • Infrastructure Maintenance Tasks
      • Inter-Server Synchronization
        • Inter-Server Synchronization version 2
      • Live Patching
        • Channel Setup for Live Patching
        • Live Patching on SLES 15
        • Live Patching on SLES 12
      • Maintenance Windows
      • mgr-sync Command
      • Monitoring with Prometheus and Grafana
      • Organizations
      • Patch Management
      • Reports Generation
      • Security
        • Master Fingerprint
        • Repository Metadata
        • Mirror Sources
        • OpenSCAP
        • Auditing Packages
      • SSL Certificates
        • Self-Signed SSL Certificates
        • Imported SSL Certificates
        • HTTP Strict Transport Security
      • Subscription Matching
      • Task Schedules
      • Tuning Changelogs
      • Users
      • Troubleshooting
        • Troubleshooting Autoinstallation
        • Troubleshooting Bare Metal Systems
        • Troubleshooting Bootstrap Repository for End-of-Life Product
        • Troubleshooting Cloned Salt Clients
        • Troubleshooting Corrupt Repositories
        • Troubleshooting Custom Channel
        • Troubleshooting Disabling the FQDNS grain
        • Troubleshooting Disk Space
        • Troubleshooting Firewalls
        • Troubleshooting High Sync Times Over WAN
        • Troubleshooting Inactive Clients
        • Troubleshooting Inter-Server Synchronization
        • Troubleshooting Local Certificates
        • Troubleshooting Login Timeout
        • Troubleshooting Mail Configuration
        • Troubleshooting Mounting /tmp with noexec
        • Troubleshooting Mounting /var/tmp with noexec
        • Troubleshooting Not Enough Disk Space
        • Troubleshooting Notifications
        • Troubleshooting OSAD and jabberd
        • Troubleshooting Packages
        • Troubleshooting Proxy Cache Repository
        • Troubleshooting Passing Grains to a Start Event
        • Troubleshooting Proxy Connections and FQDN
        • Troubleshooting Registering Cloned Clients
        • Troubleshooting Registration from Web UI fails and does not show any errors
        • Troubleshooting Registering Traditional Client as Salt minion After Deleting
        • Troubleshooting Registering Traditional RHEL Clients
        • Troubleshooting Red Hat CDN Channel and Multiple Certificates
        • Troubleshooting Renaming the Server
        • Troubleshooting Retrying to Set Up the Target System
        • Troubleshooting RPC Timeouts
        • Troubleshooting Salt Clients Shown as Down and DNS Settings
        • Troubleshooting Saltboot
        • Troubleshooting Schema Upgrade Fails
        • Troubleshooting Synchronization
        • Troubleshooting Taskomatic
        • The Web UI Fails to Load
    • Reference Guide
      • WebUI Reference
        • Home
          • Overview
          • Notification Messages
          • User Account Menu
            • My Account
            • Addresses
            • Change Email
            • Account Deactivation
          • My Preferences
          • My Organization
            • Configuration
            • Organization Trusts
            • Configuration Channels
        • Systems
          • Systems Overview
          • System Details
            • System Details Overview
            • Properties
            • Remote Command
            • Reactivation
            • Hardware
            • Migrate
            • Notes
            • Custom Info
            • Proxy
            • Software
            • Patches
            • Packages
            • Software Channels
            • Product Migration
            • Configuration
            • Provisioning
            • Groups
            • Virtualization
            • Audit
            • States
            • Formulas
            • Ansible
            • Events
          • Systems List
          • System Groups
          • System Set Manager
            • Overview
            • Task Log
          • Bootstrapping
          • Visualization
          • Advanced Search
          • Activation Keys
          • Stored Profiles
          • Custom System Info
          • Autoinstallation
            • Overview
            • Profiles
            • Unprovisioned
            • GPG and SSL Keys
            • Distributions
            • File Preservation
            • Autoinstallation Snipppets
          • Virtual Host Managers
        • Salt
          • Keys
          • Remote Commands
          • Formula Catalog
        • Images
          • Image List
          • Build
          • Profiles
          • Stores
        • Patches
          • Patch Details
          • Patch List
            • Relevant
            • All
          • Advanced Search
          • Manage Patches
          • Clone Patches
        • Software
          • Channel Details
          • Channel List
          • Package Search
          • Manage
            • Channels
            • Packages
            • Repositories
          • Distribution Channel Mapping
        • Content Lifecycle Management
          • Projects
          • Filters
        • Audit
          • CVE Audit
          • Subscription Matching
          • OpenSCAP
            • OpenSCAP Overview
            • All Scans
            • XCCDF Diff
            • Advanced Search
        • Configuration
          • Overview
          • Channels
          • Files
            • Centrally Managed
            • Locally Managed
          • Systems
            • Managed
            • Target
        • Schedule
          • Pending Actions
          • Recurring Actions
          • Completed Actions
          • Archived Actions
          • Action Chains
          • Maintenance Windows
        • Users
          • User Details
          • Users List
            • Active Users
            • Deactivated Users
            • All Users
          • System Group Configuration
        • Admin
          • Setup Wizard
          • Organizations
          • Users
          • Pay-as-you-go
          • Manager Configuration
            • General
            • Bootstrap Script
            • Organizations
            • Restart
            • Cobbler
            • Bare-metal Systems
          • ISS Configuration
            • ISS Master Setup
            • ISS Slave Setup
          • Task Schedules
          • Task Engine Status
          • Show Tomcat Logs
        • Help
          • Documentation Version
          • Release Notes
          • API
            • Overview
            • FAQ
            • Sample Scripts
      • spacecmd Reference
        • Configuring spacecmd
        • Help
        • History
        • Troubleshooting
        • spacecmd Functions
          • activationkey
          • api
          • clear
          • clear_caches
          • configchannel
          • cryptokey
          • custominfo
          • distribution
          • errata
          • filepreservation
          • get
          • group
          • kickstart
          • list_proxies
          • login
          • logout
          • org
          • package
          • proxy_container_config
          • repo
          • report
          • scap
          • schedule
          • snippet
          • softwarechannel
          • ssm
          • system
          • toggle
          • user
          • whoami
          • whoamitalkingto
          • Miscellaneous Help Topics
      • Command Line Tools
        • Configuration CLI Tools
        • Synchronization CLI Tools
        • Bootstrapping CLI Tools
        • Database CLI Tools
    • Retail Guide
      • Retail Components
      • Retail Installation
        • Retail Requirements
        • Install Uyuni Retail Server with openSUSE
        • Uyuni Retail Server Setup
        • Uyuni Retail Branch Server
        • Network Architecture
        • Set Up Retail Environment
      • Deploying Terminals
        • Terminal Deployment Basics
        • USB and Wireless Deployments
        • Deployments with Auto-Accept Keys
        • Terminal Boot Process
        • Terminal Names
        • Offline Use
        • Rate Limiting Terminals
      • Retail Formulas
      • Administration
        • Mass Configuration
        • Mass Configuration YAML Example
        • Delta Images
        • Network Administration
      • Retail Migration
        • Upgrade Branch Server
      • What Next?
    • Common Workflows
      • Configuration Management
      • Content Lifecycle Management
      • SP Upgrade via Web UI
      • Onboarding
    • Specialized Guides
      • Salt Guide
        • Terminology
        • Salt Command
        • Common Salt Commands
        • Salt States and Pillars
        • GPG Encrypted Pillars
        • Custom Salt States
        • File Locations
        • GitFS Fileserver Backend
        • Install Using Yomi
        • Configuration Modules
        • Salt Formulas
          • Formulas provided by Uyuni
          • Bind Formula
          • Branch Network Formula
          • DHCPd Formula
          • Image Sync Formula
          • Monitoring Formulas
          • PXE Formula
          • Saltboot Formula
          • TFTPd Formula
          • VsFTPd Formula
          • Yomi Formula
          • Custom Salt Formulas
        • Salt SSH
        • Rate Limiting
        • Scaling Minions
      • Large Deployments Guide
        • Hardware Requirements
        • Single Server
          • Operation Requirements
        • Multiple Servers with Hub
          • Hub Operation Requirements
          • Hub Installation
          • Hub API
          • Hub Namespaces
          • Hub Authentication
          • Hub Reporting
        • Large Retail Environments
        • Tuning Large Installations
        • Monitoring Large Scale Deployments
      • Quick Start: Public Cloud
        • Setting Up
        • Clients
      • Quick Start: SAP
        • Prepare Server
        • Prepare Clients
        • Configuration
Uyuni master
  • Uyuni
    • master
  • Uyuni
  • Reference Guide
  • WebUI Reference
  • Help
  • API
  • FAQ
     

API FAQ

The Help  API  FAQ section contains frequently asked questions related to Uyuni APIs.

Previous
Overview
Next
Sample Scripts

   Contents