Namespace: system
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
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.
-
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.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
(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.)
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
string
-
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
-
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)"
-
struct - custom value
- string "custom info label"
-
struct - server details
- int "id" - System id
- string "profile_name"
- string "base_entitlement" - System's base entitlement label
- array "string"
- 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)
-
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"
-
struct - DMI
- string "vendor"
- string "system"
- string "product"
- string "asset"
- string "board"
- string "bios_release" - (optional)
- string "bios_vendor" - (optional)
- string "bios_version" - (optional)
-
array:
- string - entitlement_label
-
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
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
struct - memory
- int "ram" - The amount of physical memory in MB.
- int "swap" - The amount of swap space in MB.
-
struct - name info
- int "id" - Server id
- string "name" - Server name
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
struct - network info
- string "ip" - IPv4 address of server
- string "ip6" - IPv6 address of server
- string "hostname" - Hostname of server
-
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" - List of IPv6 addresses
array:
-
struct - ipv6 address
- string "address" - IPv6 address of this network device
- string "netmask" - IPv6 netmask of this network device
- string "scope" - IPv6 address scope
-
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
-
dateTime.iso8601 - The date the system was registered,
in local time.
-
array:
-
struct - errata
- int "id" - Errata ID.
- string "date" - Date erratum was created.
- string "update_date" - Date erratum was updated.
- string "advisory_synopsis" - Summary of the erratum.
- string "advisory_type" - Type label such as Security, Bug Fix
- string "advisory_name" - Name such as RHSA, etc
-
array:
-
struct - errata
- int "id" - Errata ID.
- string "date" - Date erratum was created.
- string "update_date" - Date erratum was updated.
- string "advisory_synopsis" - Summary of the erratum.
- string "advisory_type" - Type label such as Security, Bug Fix
- string "advisory_name" - Name such as RHSA, etc
-
string
-
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
-
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
-
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:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
Map of score multipliers
-
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"
-
array:
-
struct - errata
- int "id" - Errata Id
- string "date" - Date erratum was created.
- string "advisory_type" - Type of the advisory.
- string "advisory_name" - Name of the advisory.
- string "advisory_synopsis" - Summary of the erratum.
-
string
-
struct - System kickstart variables
- boolean "netboot" - netboot enabled
- array "kickstart variables"
-
struct - kickstart variable
- string "key"
- string or int "value"
-
1 if package exists, 0 if not, exception is thrown
if an error occurs
-
1 if package exists, 0 if not, exception is thrown
if an error occurs
-
array:
- string - key
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - server details
- int "id" - The server's id
- string "name" - The server's name
- 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" - List of IPv6 addresses
array:
-
struct - ipv6 address
- string "address" - IPv6 address of this network device
- string "netmask" - IPv6 netmask of this network device
- string "scope" - IPv6 address scope
- 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.
-
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
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- int "id"
- string "arch_label"
-
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
-
array:
-
struct - child channel
- int "id"
- string "name"
- string "label"
- string "summary"
- string "has_license"
- string "gpg_key_url"
-
array:
-
struct - Duplicate Group
- string "hostname"
- array "systems"
-
struct - system
- int "systemId"
- string "systemName"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - Duplicate Group
- string "ip"
- array "systems"
-
struct - system
- int "systemId"
- string "systemName"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - Duplicate Group
- string "mac"
- array "systems"
-
struct - system
- int "systemId"
- string "systemName"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch" - returned only if non-zero
- string "arch"
- date "installtime" - returned only if known
-
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)
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
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"
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- int "id"
- string "arch_label"
-
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"
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
-
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
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - package profile
- int "id"
- string "name"
- string "channel"
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "arch"
- date "installtime" - returned only if known
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- int "id"
- string "arch_label"
- string "path" - The path on that file system that the package
resides
- string "provider" - The provider of the package, determined by
the gpg key it was signed with.
- dateTime.iso8601 "last_modified"
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
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
-
array:
-
struct - child channel
- int "id"
- string "name"
- string "label"
- string "summary"
- string "has_license"
- string "gpg_key_url"
-
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:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
array:
-
struct - system
- int "id"
- string "name"
-
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
differenes found.
-
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
differenes found.
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - system
- int "id" - System ID
- string "name" - System profile name
- int "extra_pkg_count" - Extra packages count
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
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 server successfully
checked in.
- string "uuid"
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
string
-
string
-
int - ID of the action scheduled, otherwise exception thrown
on error
-
int - ID of the action scheduled, otherwise exception thrown
on error
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
array:
- int - actionId
-
array:
- int - actionId
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
array:
- int - actionId
-
array:
- int - actionId
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
int - ID of the action scheduled, otherwise exception thrown
on error
-
array:
- int - actionId
-
array:
- int - actionId
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
array:
- int - actionId
-
int actionId - The action id of the scheduled action
-
int - ID of the script run action created. Can be used to fetch
results with system.getScriptResults.
-
int - ID of the script run action created. Can be used to fetch
results with system.getScriptResults.
-
int - ID of the script run action created. Can be used to fetch
results with system.getScriptResults.
-
int - ID of the script run action created. Can be used to fetch
results with system.getScriptResults.
-
int actionId - The action id of the scheduled action
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- dateTime.iso8601 "last_boot" - Last server boot time
- dateTime.iso8601 "created" - Server registration time
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int actionID - the action Id for the schedule action
on the host system.
-
int actionID - the action Id for the schedule action
on the host system.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
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