system

Available methods

Description

Provides methods to access and modify registered system.

Namespace:

system

Method: addEntitlements

HTTP POST

Description:

Add entitlements to a server. Entitlements a server already has are quietly ignored.

Parameters:

  • string sessionKey

  • int sid

  • string array entitlements

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addNote

HTTP POST

Description:

Add a new note to the given server.

Parameters:

  • string sessionKey

  • int sid

  • string subject - What the note is about.

  • string body - Content of the note.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrap

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPassword - SSH password of given user

  • string activationKey - Activation key

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrap

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPassword - SSH password of given user

  • string activationKey - Activation key

  • int proxyId - System ID of proxy to use

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrap

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPassword - SSH password of given user

  • string activationKey - Activation key

  • string reactivationKey - Reactivation key

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrap

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPassword - SSH password of given user

  • string activationKey - Activation key

  • string reactivationKey - Reactivation key

  • int proxyId - System ID of proxy to use

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapWithPrivateSshKey

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key for authentication.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPrivKey - SSH private key as a string in PEM format

  • string sshPrivKeyPass - SSH passphrase for the key (use empty string for no passphrase)

  • string activationKey - Activation key

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapWithPrivateSshKey

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key for authentication.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPrivKey - SSH private key as a string in PEM format

  • string sshPrivKeyPass - SSH passphrase for the key (use empty string for no passphrase)

  • string activationKey - Activation key

  • int proxyId - System ID of proxy to use

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapWithPrivateSshKey

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key for authentication.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPrivKey - SSH private key as a string in PEM format

  • string sshPrivKeyPass - SSH passphrase for the key (use empty string for no passphrase)

  • string activationKey - Activation key

  • string reactivationKey - Reactivation key

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapWithPrivateSshKey

HTTP POST

Description:

Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key for authentication.

Parameters:

  • string sessionKey

  • string host - Hostname or IP address of target

  • int sshPort - SSH port on target machine

  • string sshUser - SSH user on target machine

  • string sshPrivKey - SSH private key as a string in PEM format

  • string sshPrivKeyPass - SSH passphrase for the key (use empty string for no passphrase)

  • string activationKey - Activation key

  • string reactivationKey - Reactivation key

  • int proxyId - System ID of proxy to use

  • boolean saltSSH - Manage system with Salt SSH

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: changeProxy

HTTP POST

Description:

Connect given systems to another proxy.

Parameters:

  • string sessionKey

  • int array sids

  • int proxyId

Returns:

  • int array actionIds

Method: comparePackageProfile

HTTP POST

Description:

Compare a system’s packages against a package profile. In the result returned, 'this_system' represents the server provided as an input and 'other_system' represents the profile provided as an input.

Parameters:

  • string sessionKey

  • int sid

  • string profileLabel

Returns:

  • array :

  • struct package metadata

    • int "package_name_id"

    • string "package_name"

    • string "package_epoch"

    • string "package_version"

    • string "package_release"

    • string "package_arch"

    • string "this_system" - version of package on this system

    • string "other_system" - version of package on the other system

    • int "comparison"

      • 0 - no difference

      • 1 - package on this system only

      • 2 - newer package version on this system

      • 3 - package on other system only

      • 4 - newer package version on other system

Method: comparePackages

HTTP POST

Description:

Compares the packages installed on two systems.

Parameters:

  • string sessionKey

  • int sid1

  • int sid2

Returns:

  • array :

  • struct package metadata

    • int "package_name_id"

    • string "package_name"

    • string "package_epoch"

    • string "package_version"

    • string "package_release"

    • string "package_arch"

    • string "this_system" - version of package on this system

    • string "other_system" - version of package on the other system

    • int "comparison"

      • 0 - no difference

      • 1 - package on this system only

      • 2 - newer package version on this system

      • 3 - package on other system only

      • 4 - newer package version on other system

Method: createPackageProfile

HTTP POST

Description:

Create a new stored Package Profile from a systems installed package list.

Parameters:

  • string sessionKey

  • int sid

  • string profileLabel

  • string description

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: createSystemProfile

HTTP POST

Description:

Creates a system record in database for a system that is not registered. Either "hwAddress" or "hostname" prop must be specified in the "data" struct. If a system(s) matching given data exists, a SystemsExistFaultException is thrown which contains matching system IDs in its message.

Parameters:

  • string sessionKey

  • string systemName - System name

  • struct data

    • string "hwAddress" - The HW address of the network interface (MAC)

    • string "hostname" - The hostname of the profile

Returns:

  • int systemId - The id of the created system

Method: createSystemRecord

HTTP POST

Description:

Creates a cobbler system record with the specified kickstart label

Parameters:

  • string sessionKey

  • int sid

  • string ksLabel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: createSystemRecord

HTTP POST

Description:

Creates a cobbler system record for a system that is not registered.

Parameters:

  • string sessionKey

  • string systemName

  • string ksLabel

  • string kOptions

  • string comment

  • array netDevices

    • struct network device

      • string "name"

      • string "mac"

      • string "ip"

      • string "dnsname"

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteCustomValues

HTTP POST

Description:

Delete the custom values defined for the custom system information keys provided from the given system. (Note: Attempt to delete values of non-existing keys throws exception. Attempt to delete value of existing key which has assigned no values doesn’t throw exception.)

Parameters:

  • string sessionKey

  • int sid

  • string array keys

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteGuestProfiles

HTTP POST

Description:

Delete the specified list of guest profiles for a given host

Parameters:

  • string sessionKey

  • int hostId

  • string array guestNames

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteNote

HTTP POST

Description:

Deletes the given note from the server.

Parameters:

  • string sessionKey

  • int sid

  • int noteId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteNotes

HTTP POST

Description:

Deletes all notes from the server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deletePackageProfile

HTTP POST

Description:

Delete a package profile

Parameters:

  • string sessionKey

  • int profileId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteSystem

HTTP POST

Description:

Delete a system given its client certificate.

Parameters:

  • string clientCert - client certificate of the system

Returns:

  • int - 1 on success, exception thrown otherwise.

Available since API version: 10.10

Method: deleteSystem

HTTP POST

Description:

Delete a system given its server id synchronously without cleanup

Parameters:

  • string sessionKey

  • int sid

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteSystem

HTTP POST

Description:

Delete a system given its server id synchronously

Parameters:

  • string sessionKey

  • int sid

  • string cleanupType - Possible values: 'FAIL_ON_CLEANUP_ERR' - fail in case of cleanup error, 'NO_CLEANUP' - do not cleanup, just delete, 'FORCE_DELETE' - Try cleanup first but delete server anyway in case of error

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteSystems

HTTP POST

Description:

Delete systems given a list of system ids asynchronously.

Parameters:

  • string sessionKey

  • int array sids

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteSystems

HTTP POST

Description:

Delete systems given a list of system ids asynchronously.

Parameters:

  • string sessionKey

  • int array sids

  • string cleanupType - Possible values: 'FAIL_ON_CLEANUP_ERR' - fail in case of cleanup error, 'NO_CLEANUP' - do not cleanup, just delete, 'FORCE_DELETE' - Try cleanup first but delete server anyway in case of error

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteTagFromSnapshot

HTTP POST

Description:

Deletes tag from system snapshot

Parameters:

  • string sessionKey

  • int sid

  • string tagName

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: downloadSystemId

HTTP POST

Description:

Get the system ID file for a given server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string id

Method: getConnectionPath

HTTP GET

Description:

Get the list of proxies that the given system connects through in order to reach the server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct proxy connection path details

    • int "position" - position of proxy in chain. The proxy that the system connects directly to is listed in position 1.

    • int "id" - proxy system ID

    • string "hostname" - proxy host name

Method: getCpu

HTTP GET

Description:

Gets the CPU information of a system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • * struct CPU

    • string "cache"

    • string "family"

    • string "mhz"

    • string "flags"

    • string "model"

    • string "vendor"

    • string "arch"

    • string "stepping"

    • string "count"

    • int "socket_count (if available)"

Method: getCustomValues

HTTP GET

Description:

Get the custom data values defined for the server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • struct custom value

    • string "custom info label"

Method: getDetails

HTTP GET

Description:

Get system details.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • * struct server details

    • int "id" - system ID

    • string "profile_name"

    • string "machine_id"

    • string "minion_id"

    • string "base_entitlement" - system’s base entitlement label

    • string array "addon_entitlements" - system’s addon entitlements labels, currently only 'virtualization_host'

    • boolean "auto_update" - true if system has auto errata updates enabled

    • string "release" - the operating system release (i.e. 4AS, 5Server)

    • string "address1"

    • string "address2"

    • string "city"

    • string "state"

    • string "country"

    • string "building"

    • string "room"

    • string "rack"

    • string "description"

    • string "hostname"

    • dateTime.iso8601 "last_boot"

    • string "osa_status" - either 'unknown', 'offline', or 'online'

    • boolean "lock_status" - True indicates that the system is locked. False indicates that the system is unlocked.

    • string "virtualization" - virtualization type - for virtual guests only (optional)

    • string "contact_method" - one of the following:

      • default

      • ssh-push

      • ssh-push-tunnel

Method: getDevices

HTTP GET

Description:

Gets a list of devices for a system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct device

    • string "device" - optional

    • string "device_class" - Includes CDROM, FIREWIRE, HD, USB, VIDEO, OTHER, etc.

    • string "driver"

    • string "description"

    • string "bus"

    • string "pcitype"

Method: getDmi

HTTP GET

Description:

Gets the DMI information of a system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • * struct DMI

    • string "vendor"

    • string "system"

    • string "product"

    • string "asset"

    • string "board"

    • string "bios_release" - (optional)

    • string "bios_vendor" - (optional)

    • string "bios_version" - (optional)

Method: getEntitlements

HTTP GET

Description:

Gets the entitlements for a given server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string array entitlement_label

Method: getEventDetails

HTTP GET

Description:

Returns the details of the event associated with the specified server and event. The event id must be a value returned by the system.getEventHistory API.

Parameters:

  • string sessionKey

  • int sid

  • int eid - ID of the event

Returns:

  • array :

  • struct system event

    • int "id" - ID of the event

    • string "history_type" - type of history event

    • string "status" - status of the event

    • string "summary" - summary of the event

    • dateTime.iso8601 "created" - date that the event was created

    • dateTime.iso8601 "picked_up" - date that the event was picked up

    • dateTime.iso8601 "completed" - date that the event occurred

    • dateTime.iso8601 "earliest_action" - earliest date this action could occur

    • string "result_msg" - the result string of the action executed on the client machine (optional)

    • int "result_code" - the result code of the action executed on the client machine (optional)

    • array "additional_info" - additional information for the event, if available

      • struct info

        • string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information…​etc.

        • string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differences found.

Method: getEventHistory (Deprecated)

HTTP GET

Description:

Returns a list history items associated with the system, ordered from newest to oldest. Note that the details may be empty for events that were scheduled against the system (as compared to instant). For more information on such events, see the system.listSystemEvents operation. Note: This version of the method is deprecated and the return value will be changed in a future API version. Please one of the other overloaded versions of getEventHistory.

Deprecated - This version of the method is deprecated and the return value will be changed in a future API version. Please one of the other overloaded versions of getEventHistory.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct history event

    • dateTime.iso8601 "completed" - date that the event occurred (optional)

    • string "summary" - summary of the event

    • string "details" - details of the event

Method: getEventHistory

HTTP GET

Description:

Returns a list of history items associated with the system happened after the specified date. The list is paged and ordered from newest to oldest.

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso8601 earliestDate

  • int offset - Number of results to skip

  • int limit - Maximum number of results

Returns:

  • array :

  • struct system event

    • int "id" - ID of the event

    • string "history_type" - type of history event

    • string "status" - status of the event

    • string "summary" - summary of the event

    • dateTime.iso8601 "completed" - date that the event occurred

Method: getEventHistory

HTTP GET

Description:

Returns a list of history items associated with the system. The list is paged and ordered from newest to oldest.

Parameters:

  • string sessionKey

  • int sid

  • int offset - Number of results to skip

  • int limit - Maximum number of results

Returns:

  • array :

  • struct system event

    • int "id" - ID of the event

    • string "history_type" - type of history event

    • string "status" - status of the event

    • string "summary" - summary of the event

    • dateTime.iso8601 "completed" - date that the event occurred

Method: getEventHistory

HTTP GET

Description:

Returns a list of history items associated with the system happened after the specified date. The list is ordered from newest to oldest.

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso8601 earliestDate

Returns:

  • array :

  • struct system event

    • int "id" - ID of the event

    • string "history_type" - type of history event

    • string "status" - status of the event

    • string "summary" - summary of the event

    • dateTime.iso8601 "completed" - date that the event occurred

Method: getId

HTTP GET

Description:

Get system IDs and last check in information for the given system name.

Parameters:

  • string sessionKey

  • string name

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: getInstalledProducts

HTTP GET

Description:

Get a list of installed products for given system

Parameters:

  • User loggedInUser

  • int sid

Returns:

  • array :

  • struct installed product

    • string "name"

    • boolean "isBaseProduct"

    • string "version" - returned only if applies

    • string "arch" - returned only if applies

    • string "release" - returned only if applies

    • string "friendlyName" - returned only if available

Method: getKernelLivePatch

HTTP GET

Description:

Returns the currently active kernel live patching version relative to the running kernel version of the system, or empty string if live patching feature is not in use for the given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string

Method: getMemory

HTTP GET

Description:

Gets the memory information for a system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • struct memory

    • int "ram" - The amount of physical memory in MB.

    • int "swap" - The amount of swap space in MB.

Method: getMinionIdMap

HTTP GET

Description:

Return a map from Salt minion IDs to System IDs. Map entries are limited to systems that are visible by the current user.

Parameters:

  • string sessionKey

Returns:

  • map id_map - minion IDs to system IDs

Method: getName

HTTP GET

Description:

Get system name and last check in information for the given system ID.

Parameters:

  • string sessionKey

  • string sid

Returns:

  • struct name info

    • int "id" - Server id

    • string "name" - Server name

    • dateTime.iso8601 "last_checkin" - Last time server successfully checked in

Method: getNetwork

HTTP GET

Description:

Get the addresses and hostname for a given server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • struct network info

    • string "ip" - IPv4 address of server

    • string "ip6" - IPv6 address of server

    • string "hostname" - Hostname of server

Method: getNetworkDevices

HTTP GET

Description:

Returns the network devices for the given server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct network device

    • string "ip" - IP address assigned to this network device

    • string "interface" - network interface assigned to device, e.g. eth0

    • string "netmask" - network mask assigned to device

    • string "hardware_address" - hardware address of device

    • string "module" - network driver used for this device

    • string "broadcast" - broadcast address for device

    • array "ipv6" - the list of IPv6 addresses

      • struct ipv6 address

        • string "address" - IPv6 address of this network device

        • string "netmask" - IPv6 netmask of this network device

        • string "scope" - IPv6 address scope

    • array "ipv4" - the list of IPv4 addresses

      • struct ipv4 address

        • string "address" - IPv4 address of this network device

        • string "netmask" - IPv4 netmask of this network device

        • string "broadcast" - IPv4 broadcast address of this network device

Method: getNetworkForSystems

HTTP GET

Description:

Get the addresses and hostname for a given list of systems.

Parameters:

  • string sessionKey

  • int array sids

Returns:

  • array :

    • struct network info

      • int "system_id" - ID of the system

      • string "ip" - IPv4 address of system

      • string "ip6" - IPv6 address of system

      • string "hostname" - Hostname of system

      • string "primary_fqdn" - Primary FQDN of system

Method: getOsaPing

HTTP GET

Description:

get details about a ping sent to a system using OSA

Parameters:

  • User loggedInUser

  • int sid

Returns:

  • struct osaPing

    • string "state" - state of the system (unknown, online, offline)

    • dateTime.iso8601 "lastMessageTime" - time of the last received response (1970/01/01 00:00:00 if never received a response)

    • dateTime.iso8601 "lastPingTime" - time of the last sent ping (1970/01/01 00:00:00 if no ping is pending

Method: getRegistrationDate

HTTP GET

Description:

Returns the date the system was registered.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • dateTime.iso8601 date - The date the system was registered, in local time

Method: getRelevantErrata

HTTP GET

Description:

Returns a list of all errata that are relevant to the system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

Method: getRelevantErrataByType

HTTP GET

Description:

Returns a list of all errata of the specified type that are relevant to the system.

Parameters:

  • string sessionKey

  • int sid

  • string advisoryType - type of advisory (one of of the following: 'Security Advisory', 'Product Enhancement Advisory', 'Bug Fix Advisory'

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

Method: getRunningKernel

HTTP GET

Description:

Returns the running kernel of the given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string kernel

Method: getScriptActionDetails

HTTP GET

Description:

Returns script details for script run actions

Parameters:

  • string sessionKey

  • int actionId - ID of the script run action.

Returns:

  • struct Script details

    • int "id" - action id

    • string "content" - script content

    • string "run_as_user" - Run as user

    • string "run_as_group" - Run as group

    • int "timeout" - Timeout in seconds

    • array :

  • struct script result

    • int "serverId" - ID of the server the script runs on

    • dateTime.iso8601 "startDate" - time script began execution

    • dateTime.iso8601 "stopDate" - time script stopped execution

    • int "returnCode" - script execution return code

    • string "output" - output of the script (base64 encoded according to the output_enc64 attribute)

    • boolean "output_enc64" - identifies base64 encoded output

Method: getScriptResults

HTTP POST

Description:

Fetch results from a script execution. Returns an empty array if no results are yet available.

Parameters:

  • string sessionKey

  • int actionId - ID of the script run action.

Returns:

  • array :

  • struct script result

    • int "serverId" - ID of the server the script runs on

    • dateTime.iso8601 "startDate" - time script began execution

    • dateTime.iso8601 "stopDate" - time script stopped execution

    • int "returnCode" - script execution return code

    • string "output" - output of the script (base64 encoded according to the output_enc64 attribute)

    • boolean "output_enc64" - identifies base64 encoded output

Method: getSubscribedBaseChannel

HTTP GET

Description:

Provides the base channel of a given system

Parameters:

  • string sessionKey

  • int sid

Returns:

  • * struct channel

    • int "id"

    • string "name"

    • string "label"

    • string "arch_name"

    • string "arch_label"

    • string "summary"

    • string "description"

    • string "checksum_label"

    • dateTime.iso8601 "last_modified"

    • string "maintainer_name"

    • string "maintainer_email"

    • string "maintainer_phone"

    • string "support_policy"

    • string "gpg_key_url"

    • string "gpg_key_id"

    • string "gpg_key_fp"

    • dateTime.iso8601 "yumrepo_last_sync" - (optional)

    • string "end_of_life"

    • string "parent_channel_label"

    • string "clone_original"

    • array "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: getSystemCurrencyMultipliers

HTTP GET

Description:

Get the System Currency score multipliers

Parameters:

  • string sessionKey

Returns:

  • map multipliers - Map of score multipliers

Method: getSystemCurrencyScores

HTTP GET

Description:

Get the System Currency scores for all servers the user has access to

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct system currency

      • int "sid"

      • int "critical security errata count"

      • int "important security errata count"

      • int "moderate security errata count"

      • int "low security errata count"

      • int "bug fix errata count"

      • int "enhancement errata count"

      • int "system currency score"

Method: getUnscheduledErrata

HTTP GET

Description:

Provides an array of errata that are applicable to a given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: getUuid

HTTP GET

Description:

Get the UUID from the given system ID.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string uuid

Method: getVariables

HTTP GET

Description:

Lists kickstart variables set in the system record for the specified server. Note: This call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is not the case. To create a system record over xmlrpc use system.createSystemRecord

To create a system record in the Web UI  please go to
System -> <Specified System> -> Provisioning ->
Select a Kickstart profile -> Create Cobbler System Record.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • struct System kickstart variables

    • boolean "netboot" - netboot enabled

    • array "kickstart variables"

      • struct kickstart variable

        • string "key"

        • string or int "value"

Method: isNvreInstalled

HTTP GET

Description:

Check if the package with the given NVRE is installed on given system.

Parameters:

  • string sessionKey

  • int sid

  • string name - Package name.

  • string version - Package version.

  • string release - Package release.

Returns:

  • int status - 1 if package exists, 0 if not, exception is thrown if an error occurs

Method: isNvreInstalled

HTTP GET

Description:

Is the package with the given NVRE installed on given system.

Parameters:

  • string sessionKey

  • int sid

  • string name - Package name.

  • string version - Package version.

  • string release - Package release.

  • string epoch - Package epoch.

Returns:

  • int status - 1 if package exists, 0 if not, exception is thrown if an error occurs

Method: listActivationKeys

HTTP GET

Description:

List the activation keys the system was registered with. An empty list will be returned if an activation key was not used during registration.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string array key

Method: listActiveSystems

HTTP GET

Description:

Returns a list of active servers visible to the user.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listActiveSystemsDetails

HTTP GET

Description:

Given a list of server ids, returns a list of active servers' details visible to the user.

Parameters:

  • string sessionKey

  • int array sids

Returns:

  • array :

    • struct server details

      • int "id" - The server’s id

      • string "name" - The server’s name

      • string "minion_id" - The server’s minion id, in case it is a salt minion client

      • dateTime.iso8601 "last_checkin" - Last time server successfully checked in (in UTC)

      • int "ram" - The amount of physical memory in MB.

      • int "swap" - The amount of swap space in MB.

      • struct "network_devices" - The server’s network devices

  • struct network device

    • string "ip" - IP address assigned to this network device

    • string "interface" - network interface assigned to device, e.g. eth0

    • string "netmask" - network mask assigned to device

    • string "hardware_address" - hardware address of device

    • string "module" - network driver used for this device

    • string "broadcast" - broadcast address for device

    • array "ipv6" - the list of IPv6 addresses

      • struct ipv6 address

        • string "address" - IPv6 address of this network device

        • string "netmask" - IPv6 netmask of this network device

        • string "scope" - IPv6 address scope

    • array "ipv4" - the list of IPv4 addresses

      • struct ipv4 address

        • string "address" - IPv4 address of this network device

        • string "netmask" - IPv4 netmask of this network device

        • string "broadcast" - IPv4 broadcast address of this network device

      • struct "dmi_info" - The server’s dmi info

  • struct DMI

    • string "vendor"

    • string "system"

    • string "product"

    • string "asset"

    • string "board"

    • string "bios_release" - (optional)

    • string "bios_vendor" - (optional)

    • string "bios_version" - (optional)

      • struct "cpu_info" - The server’s cpu info

  • struct CPU

    • string "cache"

    • string "family"

    • string "mhz"

    • string "flags"

    • string "model"

    • string "vendor"

    • string "arch"

    • string "stepping"

    • string "count"

    • int "socket_count (if available)"

      • array "subscribed_channels" - List of subscribed channels

      • array :

        • struct channel

          • int "channel_id" - The channel id.

          • string "channel_label" - The channel label.

      • array "active_guest_system_ids" - List of virtual guest system ids for active guests

      • array :

        • int "guest_id" - The guest’s system id.

Method: listAdministrators

HTTP GET

Description:

Returns a list of users which can administer the system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct user

    • int "id"

    • string "login"

    • string "login_uc" - upper case version of the login

    • boolean "enabled" - true if user is enabled, false if the user is disabled

Method: listAllInstallablePackages

HTTP GET

Description:

Get the list of all installable packages for a given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch"

      • int "id"

      • string "arch_label"

Method: listDuplicatesByHostname

HTTP GET

Description:

List duplicate systems by Hostname.

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct Duplicate Group

      • string "hostname"

      • array "systems"

  • struct system

    • int "systemId"

    • string "systemName"

    • dateTime.iso8601 "last_checkin" - last time the server successfully checked in

Method: listDuplicatesByIp

HTTP GET

Description:

List duplicate systems by IP Address.

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct Duplicate Group

      • string "ip"

      • array "systems"

  • struct system

    • int "systemId"

    • string "systemName"

    • dateTime.iso8601 "last_checkin" - last time the server successfully checked in

Method: listDuplicatesByMac

HTTP GET

Description:

List duplicate systems by Mac Address.

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct Duplicate Group

      • string "mac"

      • array "systems"

  • struct system

    • int "systemId"

    • string "systemName"

    • dateTime.iso8601 "last_checkin" - last time the server successfully checked in

Method: listEmptySystemProfiles

HTTP GET

Description:

Returns a list of empty system profiles visible to user (created by the createSystemProfile method).

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "created" - Server creation time

    • string array "hw_address" - HW address

Method: listExtraPackages

HTTP GET

Description:

List extra packages for a system

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch" - returned only if non-zero

      • string "arch"

      • date "installtime" - returned only if known

Method: listFqdns

HTTP GET

Description:

Provides a list of FQDNs associated with a system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string array fqdn

Method: listGroups

HTTP GET

Description:

List the available groups for a given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct system group

      • int "id" - server group id

      • int "subscribed" - 1 if the given server is subscribed to this server group, 0 otherwise

      • string "system_group_name" - Name of the server group

      • string "sgid" - server group id (Deprecated)

Method: listInactiveSystems

HTTP GET

Description:

Lists systems that have been inactive for the default period of inactivity

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listInactiveSystems

HTTP GET

Description:

Lists systems that have been inactive for the specified number of days..

Parameters:

  • string sessionKey

  • int days

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listInstalledPackages

HTTP GET

Description:

List the installed packages for a given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct package

      • int "package_id" - PackageID, -1 if package is installed but not available in subscribed channels

      • string "name"

      • string "epoch"

      • string "version"

      • string "release"

      • string "arch" - architecture label

      • date "installtime" - returned only if known

      • boolean "retracted"

Method: listLatestAvailablePackage

HTTP GET

Description:

Get the latest available version of a package for each system

Parameters:

  • string sessionKey

  • int array sids

  • string packageName

Returns:

  • array :

    • struct system

      • int "id" - server ID

      • string "name" - server name

      • struct "package" - package structure

      • struct package

        • int "id"

        • string "name"

        • string "version"

        • string "release"

        • string "epoch"

        • string "arch"

Method: listLatestInstallablePackages

HTTP GET

Description:

Get the list of latest installable packages for a given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch"

      • int "id"

      • string "arch_label"

Method: listLatestUpgradablePackages

HTTP GET

Description:

Get the list of latest upgradable packages for a given system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct package

      • string "name"

      • string "arch"

      • string "from_version"

      • string "from_release"

      • string "from_epoch"

      • string "to_version"

      • string "to_release"

      • string "to_epoch"

      • string "to_package_id"

Method: listMigrationTargets

HTTP GET

Description:

List possible migration targets for a system

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct migrationtarget

      • string "ident"

      • string "friendly"

Method: listMigrationTargets

HTTP POST

Description:

List possible migration targets for a system, if excludeTargetWhereMissingSuccessors is false then valid targets without some successors will also be listed.

Parameters:

  • string sessionKey

  • int sid

  • boolean excludeTargetWhereMissingSuccessors

Returns:

  • array :

    • struct migrationtarget

      • string "ident"

      • string "friendly"

Method: listNewerInstalledPackages

HTTP GET

Description:

Given a package name, version, release, and epoch, returns the list of packages installed on the system w/ the same name that are newer.

Parameters:

  • string sessionKey

  • int sid

  • string name - Package name.

  • string version - Package version.

  • string release - Package release.

  • string epoch - Package epoch.

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch"

Method: listNotes

HTTP GET

Description:

Provides a list of notes associated with a system.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct note details

    • int "id"

    • string "subject" - subject of the note

    • string "note" - contents of the note

    • int "system_id" - the ID of the system associated with the note

    • string "creator" - creator of the note if exists (optional)

    • date "updated" - date of the last note update

Method: listOlderInstalledPackages

HTTP GET

Description:

Given a package name, version, release, and epoch, returns the list of packages installed on the system with the same name that are older.

Parameters:

  • string sessionKey

  • int sid

  • string name - Package name.

  • string version - Package version.

  • string release - Package release.

  • string epoch - Package epoch.

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch"

Method: listOutOfDateSystems

HTTP GET

Description:

Returns list of systems needing package updates.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listPackageProfiles

HTTP GET

Description:

List the package profiles in this organization

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct package profile

    • int "id"

    • string "name"

    • string "channel"

Method: listPackageState

HTTP GET

Description:

List possible migration targets for a system

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct package state

    • int "id"

    • string "name"

    • int "state_revision_id" - state revision ID

    • string "package_state_type_id" - 'INSTALLED' or 'REMOVED'

    • string "version_constraint_id" - 'LATEST' or 'ANY'

Method: listPackages (Deprecated)

HTTP GET

Description:

List the installed packages for a given system. Usage of listInstalledPackages is preferred, as it returns architecture label (not name).

Deprecated - This is here for backwards compatibility: The method returns architecture name, whereas the other endpoints return/accept architecture label. Instead of this method, use listInstalledPackages preferably.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch"

      • string "arch" - Architecture name

      • date "installtime" - returned only if known

Method: listPackagesFromChannel

HTTP GET

Description:

Provides a list of packages installed on a system that are also contained in the given channel. The installed package list did not include arch information before RHEL 5, so it is arch unaware. RHEL 5 systems do upload the arch information, and thus are arch aware.

Parameters:

  • string sessionKey

  • int sid

  • string channelLabel

Returns:

  • array :

  • struct package

    • string "name"

    • string "version"

    • string "release"

    • string "epoch"

    • int "id"

    • string "arch_label"

    • dateTime.iso8601 "last_modified"

    • string "path" - the path on that file system that the package resides

    • boolean "part_of_retracted_patch" - true if the package is a part of a retracted patch

    • string "provider" - the provider of the package, determined by the gpg key it was signed with.

Method: listPackagesLockStatus

HTTP GET

Description:

List current package locks status.

Parameters:

  • string sessionKey

  • string sid

Returns:

  • array :

    • struct package

      • int "package_id" - PackageID, -1 if package is locked but not available in subscribed channels

      • string "name"

      • string "epoch"

      • string "version"

      • string "release"

      • string "arch" - architecture label

      • string "pending status" - return only if there is a pending locking

Method: listPhysicalSystems

HTTP GET

Description:

Returns a list of all Physical servers visible to the user.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listSubscribableBaseChannels

HTTP GET

Description:

Returns a list of subscribable base channels.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct channel

      • int "id" - Base Channel ID.

      • string "name" - Name of channel.

      • string "label" - Label of Channel

      • int "current_base" - 1 indicates it is the current base channel

Method: listSubscribableChildChannels

HTTP GET

Description:

Returns a list of subscribable child channels. This only shows channels the system is not currently subscribed to.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

    • struct child channel

      • int "id"

      • string "name"

      • string "label"

      • string "summary"

      • string "has_license"

      • string "gpg_key_url"

Method: listSubscribedChildChannels

HTTP GET

Description:

Returns a list of subscribed child channels.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • array :

  • struct channel

    • int "id"

    • string "name"

    • string "label"

    • string "arch_name"

    • string "arch_label"

    • string "summary"

    • string "description"

    • string "checksum_label"

    • dateTime.iso8601 "last_modified"

    • string "maintainer_name"

    • string "maintainer_email"

    • string "maintainer_phone"

    • string "support_policy"

    • string "gpg_key_url"

    • string "gpg_key_id"

    • string "gpg_key_fp"

    • dateTime.iso8601 "yumrepo_last_sync" - (optional)

    • string "end_of_life"

    • string "parent_channel_label"

    • string "clone_original"

    • array "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: listSuggestedReboot

HTTP GET

Description:

List systems that require reboot.

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct system

      • int "id"

      • string "name"

Method: listSystemEvents

HTTP GET

Description:

List system actions of the specified type that were scheduled against the given server after the specified date. "actionType" should be exactly the string returned in the action_type field from the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a kickstart for a virtual guest.' Note: see also system.getEventHistory method which returns a history of all events.

Parameters:

  • string sessionKey

  • int sid - ID of system.

  • string actionType - Type of the action.

  • dateTime.iso8601 earliestDate

Returns:

  • array :

    • struct action

      • int "failed_count" - Number of times action failed.

      • string "modified" - Date modified. (Deprecated by modified_date)

      • dateTime.iso8601 "modified_date" - Date modified.

      • string "created" - Date created. (Deprecated by created_date)

      • dateTime.iso8601 "created_date" - Date created.

      • string "action_type"

      • int "successful_count" - Number of times action was successful.

      • string "earliest_action" - Earliest date this action will occur.

      • int "archived" - If this action is archived. (1 or 0)

      • string "scheduler_user" - available only if concrete user has scheduled the action

      • string "prerequisite" - Pre-requisite action. (optional)

      • string "name" - Name of this action.

      • int "id" - Id of this action.

      • string "version" - Version of action.

      • string "completion_time" - The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date)

      • dateTime.iso8601 "completed_date" - The date/time the event was completed. (optional)

      • string "pickup_time" - The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)

      • dateTime.iso8601 "pickup_date" - The date/time the action was picked up. (optional)

      • string "result_msg" - The result string after the action executes at the client machine. (optional)

      • array "additional_info" - This array contains additional information for the event, if available.

        • struct info

          • string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information…​etc.

          • string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differences found.

Available since API version: 10.8

Method: listSystemEvents

HTTP GET

Description:

List all system actions that were scheduled against the given server. This may require the caller to filter the result to fetch actions with a specific action type or to use the overloaded system.listSystemEvents method with actionType as a parameter. Note: see also system.getEventHistory method which returns a history of all events.

Parameters:

  • string sessionKey

  • int sid - ID of system.

Returns:

  • array :

    • struct action

      • int "failed_count" - Number of times action failed.

      • string "modified" - Date modified. (Deprecated by modified_date)

      • dateTime.iso8601 "modified_date" - Date modified.

      • string "created" - Date created. (Deprecated by created_date)

      • dateTime.iso8601 "created_date" - Date created.

      • string "action_type"

      • int "successful_count" - Number of times action was successful.

      • string "earliest_action" - Earliest date this action will occur.

      • int "archived" - If this action is archived. (1 or 0)

      • string "scheduler_user" - available only if concrete user has scheduled the action

      • string "prerequisite" - Pre-requisite action. (optional)

      • string "name" - Name of this action.

      • int "id" - Id of this action.

      • string "version" - Version of action.

      • string "completion_time" - The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date)

      • dateTime.iso8601 "completed_date" - The date/time the event was completed. (optional)

      • string "pickup_time" - The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)

      • dateTime.iso8601 "pickup_date" - The date/time the action was picked up. (optional)

      • string "result_msg" - The result string after the action executes at the client machine. (optional)

      • array "additional_info" - This array contains additional information for the event, if available.

        • struct info

          • string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information…​etc.

          • string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differences found.

Available since API version: 10.8

Method: listSystemEvents

HTTP GET

Description:

List system actions of the specified type that were scheduled against the given server. "actionType" should be exactly the string returned in the action_type field from the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a kickstart for a virtual guest.' Note: see also system.getEventHistory method which returns a history of all events.

Parameters:

  • string sessionKey

  • int sid - ID of system.

  • string actionType - Type of the action.

Returns:

  • array :

    • struct action

      • int "failed_count" - Number of times action failed.

      • string "modified" - Date modified. (Deprecated by modified_date)

      • dateTime.iso8601 "modified_date" - Date modified.

      • string "created" - Date created. (Deprecated by created_date)

      • dateTime.iso8601 "created_date" - Date created.

      • string "action_type"

      • int "successful_count" - Number of times action was successful.

      • string "earliest_action" - Earliest date this action will occur.

      • int "archived" - If this action is archived. (1 or 0)

      • string "scheduler_user" - available only if concrete user has scheduled the action

      • string "prerequisite" - Pre-requisite action. (optional)

      • string "name" - Name of this action.

      • int "id" - Id of this action.

      • string "version" - Version of action.

      • string "completion_time" - The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date)

      • dateTime.iso8601 "completed_date" - The date/time the event was completed. (optional)

      • string "pickup_time" - The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)

      • dateTime.iso8601 "pickup_date" - The date/time the action was picked up. (optional)

      • string "result_msg" - The result string after the action executes at the client machine. (optional)

      • array "additional_info" - This array contains additional information for the event, if available.

        • struct info

          • string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information…​etc.

          • string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differences found.

Available since API version: 10.8

Method: listSystemEvents

HTTP GET

Description:

List system actions of the specified type that were scheduled against the given server after the specified date. This may require the caller to filter the result to fetch actions with a specific action type or to use the overloaded system.listSystemEvents method with actionType as a parameter. Note: see also system.getEventHistory method which returns a history of all events.

Parameters:

  • string sessionKey

  • int sid - ID of system.

  • dateTime.iso8601 earliestDate

Returns:

  • array :

    • struct action

      • int "failed_count" - Number of times action failed.

      • string "modified" - Date modified. (Deprecated by modified_date)

      • dateTime.iso8601 "modified_date" - Date modified.

      • string "created" - Date created. (Deprecated by created_date)

      • dateTime.iso8601 "created_date" - Date created.

      • string "action_type"

      • int "successful_count" - Number of times action was successful.

      • string "earliest_action" - Earliest date this action will occur.

      • int "archived" - If this action is archived. (1 or 0)

      • string "scheduler_user" - available only if concrete user has scheduled the action

      • string "prerequisite" - Pre-requisite action. (optional)

      • string "name" - Name of this action.

      • int "id" - Id of this action.

      • string "version" - Version of action.

      • string "completion_time" - The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date)

      • dateTime.iso8601 "completed_date" - The date/time the event was completed. (optional)

      • string "pickup_time" - The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)

      • dateTime.iso8601 "pickup_date" - The date/time the action was picked up. (optional)

      • string "result_msg" - The result string after the action executes at the client machine. (optional)

      • array "additional_info" - This array contains additional information for the event, if available.

        • struct info

          • string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information…​etc.

          • string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differences found.

Available since API version: 10.8

Method: listSystemGroupsForSystemsWithEntitlement

HTTP GET

Description:

Returns the groups information a system is member of, for all the systems visible to the passed user and that are entitled with the passed entitlement.

Parameters:

  • string sessionKey

  • string entitlement

Returns:

  • array :

  • struct system

    • int "id" - system ID

    • array "system_groups"

      • struct system group

        • int "id" - system group ID

        • string "name" - system group name

Method: listSystems

HTTP GET

Description:

Returns a list of all servers visible to the user.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listSystemsWithEntitlement

HTTP GET

Description:

Lists the systems that have the given entitlement

Parameters:

  • string sessionKey

  • string entitlementName - the entitlement name

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listSystemsWithExtraPackages

HTTP GET

Description:

List systems with extra packages

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct system

      • int "id" - System ID

      • string "name" - System profile name

      • int "extra_pkg_count" - Extra packages count

Method: listSystemsWithPackage

HTTP GET

Description:

Lists the systems that have the given installed package

Parameters:

  • string sessionKey

  • int pid - the package id

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listSystemsWithPackage

HTTP GET

Description:

Lists the systems that have the given installed package

Parameters:

  • string sessionKey

  • string name - the package name

  • string version - the package version

  • string release - the package release

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listUngroupedSystems

HTTP GET

Description:

List systems that are not associated with any system groups.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listUserSystems

HTTP GET

Description:

List systems for a given user.

Parameters:

  • string sessionKey

  • string login - User’s login name.

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listUserSystems

HTTP GET

Description:

List systems for the logged in user.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listVirtualGuests

HTTP GET

Description:

Lists the virtual guests for a given virtual host

Parameters:

  • string sessionKey

  • int sid - the virtual host’s id

Returns:

  • array :

  • struct virtual system

    • int "id"

    • string "name"

    • string "guest_name" - the virtual guest name as provided by the virtual host

    • dateTime.iso8601 "last_checkin" - last time the server successfully checked in

    • string "uuid"

Method: listVirtualHosts

HTTP GET

Description:

Lists the virtual hosts visible to the user

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: obtainReactivationKey

HTTP POST

Description:

Obtains a reactivation key for this server.

Parameters:

  • string sessionKey

  • int sid

Returns:

  • string key

Method: obtainReactivationKey

HTTP POST

Description:

Obtains a reactivation key for this server.

Parameters:

  • string clientCert - client certificate of the system

Returns:

  • string key

Available since API version: 10.10

Method: provisionSystem

HTTP POST

Description:

Provision a system using the specified kickstart/autoinstallation profile.

Parameters:

  • string sessionKey

  • int sid - ID of the system to be provisioned.

  • string profileName - Profile to use.

Returns:

  • int id - ID of the action scheduled, otherwise exception thrown on error

Method: provisionSystem

HTTP POST

Description:

Provision a system using the specified kickstart/autoinstallation profile.

Parameters:

  • string sessionKey

  • int sid - ID of the system to be provisioned.

  • string profileName - Profile to use.

  • dateTime.iso8601 earliestDate

Returns:

  • int id - ID of the action scheduled, otherwise exception thrown on error

Method: provisionVirtualGuest

HTTP POST

Description:

Provision a guest on the host specified. Defaults to: memory=512MB, vcpu=1, storage=3GB, mac_address=random.

Parameters:

  • string sessionKey

  • int sid - ID of host to provision guest on.

  • string guestName

  • string profileName - Kickstart profile to use.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: provisionVirtualGuest

HTTP POST

Description:

Provision a guest on the host specified. This schedules the guest for creation and will begin the provisioning process when the host checks in or if OSAD is enabled will begin immediately. Defaults to mac_address=random.

Parameters:

  • string sessionKey

  • int sid - ID of host to provision guest on.

  • string guestName

  • string profileName - Kickstart Profile to use.

  • int memoryMb - Memory to allocate to the guest

  • int vcpus - Number of virtual CPUs to allocate to the guest.

  • int storageGb - Size of the guests disk image.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: provisionVirtualGuest

HTTP POST

Description:

Provision a guest on the host specified. This schedules the guest for creation and will begin the provisioning process when the host checks in or if OSAD is enabled will begin immediately.

Parameters:

  • string sessionKey

  • int sid - ID of host to provision guest on.

  • string guestName

  • string profileName - Kickstart Profile to use.

  • int memoryMb - Memory to allocate to the guest

  • int vcpus - Number of virtual CPUs to allocate to the guest.

  • int storageGb - Size of the guests disk image.

  • string macAddress - macAddress to give the guest’s virtual networking hardware.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: refreshPillar

HTTP POST

Description:

refresh all the pillar data of a list of systems.

Parameters:

  • string sessionKey

  • int array sids

Returns:

  • int array skippedIds

Method: refreshPillar

HTTP POST

Description:

refresh the pillar data of a list of systems. The subset value represents the pillar to be refreshed and can be one of 'general', 'group_membership', 'virtualization' or 'custom_info'.

Parameters:

  • string sessionKey

  • string subset

  • int array sids

Returns:

  • int array skippedIds

Method: removeEntitlements

HTTP POST

Description:

Remove addon entitlements from a server. Entitlements a server does not have are quietly ignored.

Parameters:

  • string sessionKey

  • int sid

  • string array entitlements

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to multiple systems.

Parameters:

  • string sessionKey

  • int array sids

  • int array errataIds

Returns:

  • int array actionId

Available since API version: 13.0

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to multiple systems.

Parameters:

  • string sessionKey

  • int array sids

  • int array errataIds

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to multiple systems at a given date/time.

Parameters:

  • string sessionKey

  • int array sids

  • int array errataIds

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Available since API version: 13.0

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to multiple systems at a given date/time.

Parameters:

  • string sessionKey

  • int array sids

  • int array errataIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to multiple systems at a given date/time.

Parameters:

  • string sessionKey

  • int array sids

  • int array errataIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

  • boolean onlyRelevant - If true not all erratas are applied to all systems. Systems get only the erratas relevant for them.

Returns:

  • int array actionId

Available since API version: 24

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to a system.

Parameters:

  • string sessionKey

  • int sid

  • int array errataIds

Returns:

  • int array actionId

Available since API version: 13.0

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to a system.

Parameters:

  • string sessionKey

  • int sid

  • int array errataIds

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to a system at a given date/time.

Parameters:

  • string sessionKey

  • int sid

  • int array errataIds

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Available since API version: 13.0

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to a system at a given date/time.

Parameters:

  • string sessionKey

  • int sid

  • int array errataIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: scheduleApplyErrata

HTTP POST

Description:

Schedules an action to apply errata updates to a system at a given date/time.

Parameters:

  • string sessionKey

  • int sid

  • int array errataIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

  • boolean onlyRelevant

Returns:

  • int array actionId

Available since API version: 24

Method: scheduleApplyHighstate

HTTP POST

Description:

Schedule highstate application for a given system.

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso8601 earliestOccurrence

  • boolean test - Run states in test-only mode

Returns:

  • int actionId

Method: scheduleApplyHighstate

HTTP POST

Description:

Schedule highstate application for a given system.

Parameters:

  • string sessionKey

  • int array sids

  • dateTime.iso8601 earliestOccurrence

  • boolean test - Run states in test-only mode

Returns:

  • int actionId

Method: scheduleApplyStates

HTTP POST

Description:

Schedule highstate application for a given system.

Parameters:

  • string sessionKey

  • int sid

  • string array stateNames

  • dateTime.iso8601 earliestOccurrence

  • boolean test - Run states in test-only mode

Returns:

  • int actionId

Method: scheduleApplyStates

HTTP POST

Description:

Schedule highstate application for a given system.

Parameters:

  • string sessionKey

  • int array sids

  • string array stateNames

  • dateTime.iso8601 earliestOccurrence

  • boolean test - Run states in test-only mode

Returns:

  • int actionId

Method: scheduleCertificateUpdate

HTTP POST

Description:

Schedule update of client certificate

Parameters:

  • string sessionKey

  • int sid

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleCertificateUpdate

HTTP POST

Description:

Schedule update of client certificate at given date and time

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso860 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleChangeChannels

HTTP POST

Description:

Schedule an action to change the channels of the given system. Works for both traditional and Salt systems. This method accepts labels for the base and child channels. If the user provides an empty string for the channelLabel, the current base channel and all child channels will be removed from the system.

Parameters:

  • string sessionKey

  • int sid

  • string baseChannelLabel

  • string array childLabels

  • dateTime.iso8601 earliestOccurrence - the time/date to schedule the action

Returns:

  • int id - ID of the action scheduled, otherwise exception thrown on error

Available since API version: 19.0

Method: scheduleChangeChannels

HTTP POST

Description:

Schedule an action to change the channels of the given system. Works for both traditional and Salt systems. This method accepts labels for the base and child channels. If the user provides an empty string for the channelLabel, the current base channel and all child channels will be removed from the system.

Parameters:

  • string sessionKey

  • int array sids

  • string baseChannelLabel

  • string array childLabels

  • dateTime.iso8601 earliestOccurrence - the time/date to schedule the action

Returns:

  • long array actionIds

Available since API version: 19.0

Method: scheduleDistUpgrade

HTTP POST

Description:

Schedule a dist upgrade for a system. This call takes a list of channel labels that the system will be subscribed to before performing the dist upgrade. Note: You can seriously damage your system with this call, use it only if you really know what you are doing! Make sure that the list of channel labels is complete and in any case do a dry run before scheduling an actual dist upgrade.

Parameters:

  • string sessionKey

  • int sid

  • string array channels

  • boolean dryRun

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId

Method: scheduleDistUpgrade

HTTP POST

Description:

Schedule a dist upgrade for a system. This call takes a list of channel labels that the system will be subscribed to before performing the dist upgrade. Note: You can seriously damage your system with this call, use it only if you really know what you are doing! Make sure that the list of channel labels is complete and in any case do a dry run before scheduling an actual dist upgrade.

Parameters:

  • string sessionKey

  • int sid

  • string array channels

  • boolean dryRun

  • boolean allowVendorChange

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId

Method: scheduleGuestAction

HTTP POST

Description:

Schedules a guest action for the specified virtual guest for a given date/time.

Parameters:

  • string sessionKey

  • int sid - the system Id of the guest

  • string state - One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.

  • dateTime.iso8601 date - the time/date to schedule the action

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleGuestAction

HTTP POST

Description:

Schedules a guest action for the specified virtual guest for the current time.

Parameters:

  • string sessionKey

  • int sid - the system Id of the guest

  • string state - One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleHardwareRefresh

HTTP POST

Description:

Schedule a hardware refresh for a system.

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 13.0

Method: schedulePackageInstall

HTTP POST

Description:

Schedule package installation for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Method: schedulePackageInstall

HTTP POST

Description:

Schedule package installation for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: schedulePackageInstall

HTTP POST

Description:

Schedule package installation for a system.

Parameters:

  • string sessionKey

  • int sid

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 13.0

Method: schedulePackageInstall

HTTP POST

Description:

Schedule package installation for a system.

Parameters:

  • string sessionKey

  • int sid

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 21

Method: schedulePackageInstallByNevra

HTTP POST

Description:

Schedule package installation for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • array packageNevraList

    • struct Package Nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Method: schedulePackageInstallByNevra

HTTP POST

Description:

Schedule package installation for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: schedulePackageInstallByNevra

HTTP POST

Description:

Schedule package installation for a system.

Parameters:

  • string sessionKey

  • int sid

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: schedulePackageInstallByNevra

HTTP POST

Description:

Schedule package installation for a system.

Parameters:

  • string sessionKey

  • int sid

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 21

Method: schedulePackageLockChange

HTTP POST

Description:

Schedule package lock for a system.

Parameters:

  • string sessionKey

  • int sid

  • int array pkgIdsToLock

  • int array pkgIdsToUnlock

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: schedulePackageRefresh

HTTP POST

Description:

Schedule a package list refresh for a system.

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int id - ID of the action scheduled, otherwise exception thrown on error

Method: schedulePackageRemove

HTTP POST

Description:

Schedule package removal for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Method: schedulePackageRemove

HTTP POST

Description:

Schedule package removal for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: schedulePackageRemove

HTTP POST

Description:

Schedule package removal for a system.

Parameters:

  • string sessionKey

  • int sid

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: schedulePackageRemove

HTTP POST

Description:

Schedule package removal for a system.

Parameters:

  • string sessionKey

  • int sid

  • int array packageIds

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 21

Method: schedulePackageRemoveByNevra

HTTP POST

Description:

Schedule package removal for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Method: schedulePackageRemoveByNevra

HTTP POST

Description:

Schedule package removal for several systems.

Parameters:

  • string sessionKey

  • int array sids

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: schedulePackageRemoveByNevra

HTTP POST

Description:

Schedule package removal for a system.

Parameters:

  • string sessionKey

  • int sid

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int array actionId

Method: schedulePackageRemoveByNevra

HTTP POST

Description:

Schedule package removal for a system.

Parameters:

  • string sessionKey

  • int sid

  • array packageNevraList

    • struct Package nevra

      • string "package_name"

      • string "package_epoch"

      • string "package_version"

      • string "package_release"

      • string "package_arch"

  • dateTime.iso8601 earliestOccurrence

  • boolean allowModules - Allow this API call, despite modular content being present

Returns:

  • int array actionId

Available since API version: 21

Method: schedulePackageUpdate

HTTP POST

Description:

Schedule full package update for several systems.

Parameters:

  • string sessionKey

  • int array serverId

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId

Available since API version: 25

Method: scheduleProductMigration

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Parameters:

  • string sessionKey

  • int sid

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleProductMigration

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Parameters:

  • string sessionKey

  • int sid

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • boolean allowVendorChange

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleProductMigration

HTTP POST

Description:

Schedule a Prodcut migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Parameters:

  • string sessionKey

  • int sid

  • string targetIdent - Identifier for the selected migration target. Use listMigrationTargets to list the identifiers

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleProductMigration

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Parameters:

  • string sessionKey

  • int sid

  • string targetIdent - Identifier for the selected migration target. Use listMigrationTargets to list the identifiers

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • boolean allowVendorChange

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleProductMigration

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Parameters:

  • string sessionKey

  • int sid

  • string targetIdent - Identifier for the selected migration target - User listMigrationTargets to list the identifiers

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • boolean allowVendorChange

  • boolean removeProductsWithNoSuccessorAfterMigration - set to remove products which have no successors. This flag will only have effect if targetIdent will also be specified

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleReboot

HTTP POST

Description:

Schedule a reboot for a system.

Parameters:

  • string sessionKey

  • int sid

  • dateTime.iso860 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 13.0

Method: scheduleSPMigration (Deprecated)

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Note: This method is deprecated and will be removed in a future API version. Please use
scheduleProductMigration instead.

Deprecated - being replaced by scheduleProductMigration(User loggedInUser, Integer sid, String baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, Date earliest)

Parameters:

  • string sessionKey

  • int sid

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleSPMigration (Deprecated)

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Note: This method is deprecated and will be removed in a future API version. Please use
scheduleProductMigration instead.

Deprecated - being replaced by scheduleProductMigration(User loggedInUser, Integer sid, String baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, boolean allowVendorChange, Date earliest)

Parameters:

  • string sessionKey

  • int sid

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • boolean allowVendorChange

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleSPMigration (Deprecated)

HTTP POST

Description:

Schedule a Prodcut migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Note: This method is deprecated and will be removed in a future API version. Please use
scheduleProductMigration instead.

Deprecated - being replaced by scheduleProductMigration(User loggedInUser, Integer sid, String targetIdent, String baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, Date earliest)

Parameters:

  • string sessionKey

  • int sid

  • string targetIdent - identifier for the selected migration target. User listMigrationTargets to list the identifiers

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleSPMigration (Deprecated)

HTTP POST

Description:

Schedule a Product migration for a system. This call is the recommended and supported way of migrating a system to the next Service Pack. It will automatically find all mandatory product channels below a given target base channel and subscribe the system accordingly. Any additional optional channels can be subscribed by providing their labels.

Note: This method is deprecated and will be removed in a future API version. Please use
scheduleProductMigration instead.

Deprecated - being replaced by scheduleProductMigration(User loggedInUser, Integer sid, String targetIdent, String baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, boolean allowVendorChange, Date earliest)

Parameters:

  • string sessionKey

  • int sid

  • string targetIdent - Identifier for the selected migration target. Use listMigrationTargets to list the identifiers

  • string baseChannelLabel

  • string array optionalChildChannels

  • boolean dryRun

  • boolean allowVendorChange

  • dateTime.iso8601 earliestOccurrence

Returns:

  • int actionId - The action id of the scheduled action

Method: scheduleScriptRun

HTTP POST

Description:

Schedule a script to run.

Parameters:

  • string sessionKey

  • string label

  • int array sids - System IDs of the servers to run the script on.

  • string username - User to run script as.

  • string groupname - Group to run script as.

  • int timeout - Seconds to allow the script to run before timing out.

  • string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)

  • dateTime.iso8601 earliestOccurrence - Earliest the script can run.

Returns:

  • int id - ID of the script run action created. Can be used to fetch results with system.getScriptResults

Method: scheduleScriptRun

HTTP POST

Description:

Schedule a script to run.

Parameters:

  • string sessionKey

  • int array sids

  • string username - User to run script as.

  • string groupname - Group to run script as.

  • int timeout - Seconds to allow the script to run before timing out.

  • string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)

  • dateTime.iso8601 earliestOccurrence - Earliest the script can run.

Returns:

  • int id - ID of the script run action created. Can be used to fetch results with system.getScriptResults

Method: scheduleScriptRun

HTTP POST

Description:

Schedule a script to run.

Parameters:

  • string sessionKey

  • int sid - ID of the server to run the script on.

  • string username - User to run script as.

  • string groupname - Group to run script as.

  • int timeout - Seconds to allow the script to run before timing out.

  • string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)

  • dateTime.iso8601 earliestOccurrence - Earliest the script can run.

Returns:

  • int id - ID of the script run action created. Can be used to fetch results with system.getScriptResults

Method: scheduleScriptRun

HTTP POST

Description:

Schedule a script to run.

Parameters:

  • string sessionKey

  • string label

  • int sid - ID of the server to run the script on.

  • string username - User to run script as.

  • string groupname - Group to run script as.

  • int timeout - Seconds to allow the script to run before timing out.

  • string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)

  • dateTime.iso8601 earliestOccurrence - Earliest the script can run.

Returns:

  • int id - ID of the script run action created. Can be used to fetch results with system.getScriptResults

Method: scheduleSyncPackagesWithSystem

HTTP POST

Description:

Sync packages from a source system to a target.

Parameters:

  • string sessionKey

  • int targetServerId - Target system to apply package changes to.

  • int sourceServerId - Source system to retrieve package state from.

  • int array packageIds - Package IDs to be synced.

  • dateTime.iso8601 earliestOccurrence - Date to schedule action for

Returns:

  • int actionId - The action id of the scheduled action

Available since API version: 13.0

Method: searchByName

HTTP POST

Description:

Returns a list of system IDs whose name matches the supplied regular expression(defined by

Java representation of regular expressions)

Parameters:

  • string sessionKey

  • string regexp - A regular expression

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: sendOsaPing

HTTP POST

Description:

send a ping to a system using OSA

Parameters:

  • string sessionKey

  • int serverId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setBaseChannel (Deprecated)

HTTP POST

Description:

Assigns the server to a new baseChannel.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel)

Parameters:

  • string sessionKey

  • int sid

  • int cid - channel ID

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setBaseChannel (Deprecated)

HTTP POST

Description:

Assigns the server to a new base channel. If the user provides an empty string for the channelLabel, the current base channel and all child channels will be removed from the system.

Deprecated - being replaced by system.scheduleChangeChannels(string sessionKey, int serverId, String baseChannelLabel, array_single channelLabels, date earliestOccurrence).

Parameters:

  • string sessionKey

  • int sid

  • string channelLabel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setChildChannels (Deprecated)

HTTP POST

Description:

Subscribe the given server to the child channels provided. This method will unsubscribe the server from any child channels that the server is currently subscribed to, but that are not included in the list. The user may provide either a list of channel ids (int) or a list of channel labels (string) as input. Changes to channel assignments on salt managed systems will take effect at next highstate application.

Deprecated - being replaced by system.scheduleChangeChannels(string sessionKey, int serverId, String baseChannelLabel, array_single channelLabels, date earliestOccurrence). This method will schedule an action for changing the child channels immediately.

Parameters:

  • string sessionKey

  • int sidd

  • int (deprecated) or string array channelIdsOrLabels - channelId (deprecated) or channelLabel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setCustomValues

HTTP POST

Description:

Set custom values for the specified server.

Parameters:

  • string sessionKey

  • int sid

  • struct values

    • string "custom info label"

    • string "value"

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setDetails

HTTP POST

Description:

Set server details. All arguments are optional and will only be modified if included in the struct.

Parameters:

  • string sessionKey

  • int sid - ID of server to lookup details for.

  • struct details

    • string "profile_name" - System’s profile name

    • string "base_entitlement" - System’s base entitlement label. (enterprise_entitled or unentitle)

    • boolean "auto_errata_update" - True if system has auto errata updates enabled

    • string "description" - System description

    • string "address1" - System’s address line 1.

    • string "address2" - System’s address line 2.

    • string "city"

    • string "state"

    • string "country"

    • string "building"

    • string "room"

    • string "rack"

    • string "contact_method" - One of the following:

      • default

      • ssh-push

      • ssh-push-tunnel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setGroupMembership

HTTP POST

Description:

Set a servers membership in a given group.

Parameters:

  • string sessionKey

  • int sid

  • int sgid

  • boolean member - '1' to assign the given server to the given server group, '0' to remove the given server from the given server group.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setGuestCpus

HTTP POST

Description:

Schedule an action of a guest’s host, to set that guest’s CPU allocation

Parameters:

  • string sessionKey

  • int sid - The guest’s system id

  • int numOfCpus - The number of virtual cpus to allocate to the guest

Returns:

  • int actionID - the action Id for the schedule action on the host system

Method: setGuestMemory

HTTP POST

Description:

Schedule an action of a guest’s host, to set that guest’s memory allocation

Parameters:

  • string sessionKey

  • int sid - The guest’s system id

  • int memory - The amount of memory to allocate to the guest

Returns:

  • int actionID - the action Id for the schedule action on the host system

Method: setLockStatus

HTTP POST

Description:

Set server lock status.

Parameters:

  • string sessionKey

  • int sid

  • boolean lockStatus - true to lock the system, false to unlock the system.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setPrimaryFqdn

HTTP POST

Description:

Sets new primary FQDN

Parameters:

  • string sessionKey

  • int sid

  • string fqdn

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setPrimaryInterface

HTTP POST

Description:

Sets new primary network interface

Parameters:

  • string sessionKey

  • int sid

  • string interfaceName

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setProfileName

HTTP POST

Description:

Set the profile name for the server.

Parameters:

  • string sessionKey

  • int sid

  • string name - Name of the profile.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setVariables

HTTP POST

Description:

Sets a list of kickstart variables in the cobbler system record for the specified server. Note: This call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is not the case. To create a system record over xmlrpc use system.createSystemRecord

To create a system record in the Web UI  please go to
System -> <Specified System> -> Provisioning ->
Select a Kickstart profile -> Create Cobbler System Record.

Parameters:

  • string sessionKey

  • int sid

  • boolean netboot

  • struct variables

    • string "key"

    • string or int "value"

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: tagLatestSnapshot

HTTP POST

Description:

Tags latest system snapshot

Parameters:

  • string sessionKey

  • int sid

  • string tagName

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: unentitle

HTTP POST

Description:

Unentitle the system completely

Parameters:

  • string clientCert - client system id file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: updatePackageState

HTTP POST

Description:

Update the package state of a given system (High state would be needed to actually install/remove the package)

Parameters:

  • string sessionKey

  • int sid

  • string packageName - Name of the package

  • int state - 0 = installed, 1 = removed, 2 = unmanaged

  • int versionConstraint - 0 = latest, 1 = any

Returns:

  • 1 on success, exception on failure

Method: upgradeEntitlement

HTTP POST

Description:

Adds an entitlement to a given server.

Parameters:

  • string sessionKey

  • int sid

  • string entitlementLevel - One of: 'enterprise_entitled' or 'virtualization_host'.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: whoRegistered

HTTP POST

Description:

Returns information about the user who registered the system

Parameters:

  • string sessionKey

  • int sid - Id of the system in question

Returns:

  • * struct user

    • int "id"

    • string "login"

    • string "login_uc" - upper case version of the login

    • boolean "enabled" - true if user is enabled, false if the user is disabled