Resources
 uyuni-docs  Report Issue  Contribute
Language
 English  한국어  日本語  中文

Uyuni 2025.07

    • Installation and Upgrade Guide
      • Requirements
        • General Requirements
        • Network Requirements
        • Public Cloud Requirements
      • Deployment and Installation
        • Server
          • Server Deployment on openSUSE Leap Micro
          • Air-gapped Deployment
        • Proxy
          • Containerized Uyuni Proxy Setup
          • Proxy Deployment on openSUSE Leap Micro
          • Uyuni Proxy Conversion From Client
          • Proxy Deployment on K3s
      • Upgrade and Migration
        • Server
          • Legacy Server Migration to Container
          • Server Upgrade
        • Proxy
          • Legacy Proxy Migration to Container
          • Proxy Upgrade
        • Clients
          • Upgrading Clients
      • Basic Server and Proxy Management
        • Custom YAML Configuration With mgradm
        • Starting and Stopping Containers
        • Server and Proxy Containers
        • Persistent Container Volumes
        • Storage Scripts
    • Client Configuration Guide
      • Supported Clients and Features
        • SLES and openSUSE Leap Supported Features
        • SLE Micro Supported Features
        • SL Micro Supported Features
        • openSUSE Leap Micro Supported Features
        • Alibaba Cloud Linux Supported Features
        • AlmaLinux Supported Features
        • Amazon Linux Supported Features
        • CentOS Supported Features
        • Debian Supported Features
        • openEuler Supported Features
        • OES Supported Features
        • Oracle Supported Features
        • Raspberry Pi OS Supported Features
        • Red Hat Supported Features
        • Rocky Linux Supported Features
        • Ubuntu Supported Features
      • Configuration Basics
        • Software Channels
          • Software Repositories
          • Software Products
          • AppStreams
        • Bootstrap Repository
        • Activation Keys
        • GPG Keys
      • Client Contact Methods
        • Default (Salt)
        • SSH Push
        • SSH Push (With Tunnel)
        • Salt Bundle
      • Client Registration
        • Registration Methods
          • Register With the Web UI
          • Register With a Bootstrap Script
          • Register on the Command Line
        • SUSE Client Registration
          • SUSE Linux Enterprise Clients
          • SLE Micro Clients
          • SL Micro Clients
        • openSUSE Client Registration
          • openSUSE Leap Clients
          • openSUSE Leap Micro Clients
        • 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
        • openEuler Client Registration
          • openEuler Clients
        • OES Client Registration
          • Open Enterprise Server Clients
        • Oracle Client Registration
          • Oracle Clients
        • Raspberry Pi OS Client Registration
          • Raspberry Pi OS Clients
        • Red Hat Client Registration
          • Red Hat Clients - CDN
          • Red Hat Clients - RHUI
        • Rocky Linux Client Registration
          • Rocky Linux Clients
        • Ubuntu Client Registration
          • Ubuntu 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
        • Upgrade Using the Content Lifecycle Manager
        • Product Migration
        • openSUSE Leap Minor Version Upgrade
      • Client Deletion
      • Client Operations
        • Package Management
        • Patch Management
        • System Locking
        • Configuration Management
        • Power Management
        • Custom System Information
        • System Set Manager
        • System Groups
        • System Types
      • Operating System Installation
        • Reinstall Registered Systems
        • 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 Nutanix
        • VHM and VMware
        • VHM With Other Hosts
    • Administration Guide
      • Actions
      • Authentication Methods
        • Authentication With SSO
          • Example SSO Implementation
        • Authentication With PAM
      • Backup and Restore
      • Channel Management
        • Custom Channels
      • Confidential Computing
      • Content Lifecycle Management
        • Content Lifecycle Management Examples
      • Content Staging
      • Disconnected Setup
      • Disk Space Management
      • Image Building and Management
      • Infrastructure Maintenance Tasks
      • 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
      • Program Temporary Fixes
      • Reports Generation
      • Security
        • Auditing Packages
        • Master Fingerprint
        • Mirror Sources
        • OpenSCAP
        • Repository Metadata
      • Role-Based Access Control (RBAC)
      • SSL Certificates
        • Self-Signed SSL Certificates
        • Import SSL Certificates
        • HTTP Strict Transport Security
      • Subscription Matching
      • Task Schedules
      • Tuning Changelogs
      • Users
      • Troubleshooting
        • Autoinstallation
        • Bootstrap Repository for End-of-Life Product
        • Cloned Salt Clients
        • Container with Full Disk
        • Corrupt Repositories
        • Custom Channel
        • Disabling the FQDNS grain
        • Disk Space
        • Firewalls
        • High Sync Times Over WAN
        • Inactive Clients
        • Inter-Server Synchronization
        • Local Certificates
        • Login Timeout
        • Mail Configuration
        • Mounting /tmp with noexec
        • Mounting /var/tmp with noexec
        • Not Enough Disk Space
        • Notifications
        • Packages
        • Passing Grains to a Start Event
        • Proxy Connections and FQDN
        • Registering Cloned Clients
        • Remote root login on SUSE Linux Micro
        • Registering Deleted Clients
        • Registration from Web UI fails and does not show any errors
        • Red Hat CDN Channel and Multiple Certificates
        • Renaming the Server
        • RPC Timeouts
        • Salt Clients Shown as Down and DNS Settings
        • Schema Upgrade Fails
        • Synchronization
        • Taskomatic
        • 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 List
          • System Groups
          • System Set Manager
            • Overview
            • Task Log
          • Bootstrapping
          • Proxy Configuration
          • Advanced Search
          • Activation Keys
          • Stored Profiles
          • Custom System Info
          • Autoinstallation
            • Overview
            • Profiles
            • GPG and SSL Keys
            • Distributions
            • File Preservation
            • Autoinstallation Snipppets
          • Virtual Host Managers
        • System Details
          • System Details Overview
            • Properties
            • Remote Command
            • Reactivation
            • Hardware
            • Transfer
            • Notes
            • Custom Info
          • Software
            • Patches
            • Packages
            • AppStreams
            • Software Channels
            • Product Migration
          • Configuration
          • Provisioning
          • Groups
          • Audit
          • States
          • Formulas
          • Ansible
            • Recurring Actions
          • Events
          • Proxy
          • Virtualization
        • 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
          • Failed 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
          • Manager Configuration
            • General
            • Bootstrap Script
            • Organizations
            • Restart
            • Cobbler
            • Monitoring
          • 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
        • Synchronization CLI Tools
        • Channel Management CLI Tools
        • Bootstrapping CLI Tools
        • Database CLI Tools
    • Retail Guide
      • Retail Components
      • Retail Requirements
      • Network Architecture
      • Retail Configuration
        • Install Uyuni Retail Server with openSUSE
        • Uyuni Retail Server Setup
        • Uyuni Retail Branch Server
        • Set Up Retail Environment
        • Set Up Retail Environment with 4.3 proxy
      • Deploying Terminals
        • Terminal Deployment Basics
        • USB and Wireless Deployments
        • Deployments with Auto-Accept Keys
        • Forced image redeployment
        • Terminal Boot Process
        • Terminal Names
        • Offline Use
        • Rate Limiting Terminals
      • Retail Formulas
      • Image Pillars
      • Administration
        • Mass Configuration
        • Mass Configuration YAML Example
        • Delta Images
      • Upgrade Branch Server
      • Example Configurations
        • Retail Environment using Containerized Proxy
      • Best Practices
      • What Next?
    • Common Workflows
      • Client Onboarding
      • Clients Update with Recurring Actions
      • Configuration Management
      • Content Lifecycle Management
      • Product Upgrade via Web UI
    • 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
          • Liberate Formula
          • Monitoring Formulas
          • PXE Formula
          • Saline Formula
          • Saltboot Formula
          • TFTPd Formula
          • Virtualization Guest Formula
          • Virtualization Host Formula
          • Yomi Formula
          • Custom Salt Formulas
        • Salt SSH
        • Rate Limiting
        • Scaling Minions
        • Salt Connectivity
        • Monitoring Salt
        • Salt Timeouts
      • Large Deployments Guide
        • Hardware Requirements
        • Single Server
          • Operation Requirements
        • Multiple Servers with Hub
          • Hub Deployment with Peripheral Servers
          • Hub XMLRPC API Usage
          • Hub Namespaces
          • Hub Authentication
          • Hub Reporting
          • Hub Online Synchronization
          • Inter-Server Synchronization version 2
        • Large Retail Environments
        • Tuning Large Installations
        • Monitoring Large Scale Deployments
      • Quick Start: SAP
        • Prepare Server
        • Prepare Clients
        • Configuration
    • Legal
      • GNU Free Documentation License
      • Copyright Notice
Uyuni 2025.07 default
  • Uyuni 2025.07
    • default
Uyuni 2025.07 | Library
  • Reference Guide
Edit this Page

API FAQ

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

See: https://documentation.suse.com/multi-linux-manager/2025.07/api/docs/api/faqs.html

Overview Sample Scripts