Namespace: activationkey
-
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.
Available since: 10.2
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
1 if enabled, 0 if disabled, exception thrown otherwise.
-
string - The new activation key.
-
string - The new activation key.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- string childChannelLabel
- array "entitlements"
- string entitlementLabel
- array "server_group_ids"
- string serverGroupId
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
Available since: 10.2
-
array:
-
struct - system structure
- int "id" - System id
- string "hostname"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- string childChannelLabel
- array "entitlements"
- string entitlementLabel
- array "server_group_ids"
- string serverGroupId
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
Available since: 10.2
-
array:
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
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.
Available since: 10.2
-
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.
Namespace: api
-
struct - method_info
- string "name" - method name
- string "parameters" - method parameters
- string "exceptions" - method exceptions
- string "return" - method return type
-
struct - method_info
- string "name" - method name
- string "parameters" - method parameters
- string "exceptions" - method exceptions
- string "return" - method return type
-
struct - namespace
- string "namespace" - API namespace
- string "handler" - API Handler
-
string
-
string
Namespace: auth
-
string sessionKey
-
string sessionKey
-
int - 1 on success, exception thrown otherwise.
Namespace: channel
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
-
array:
-
struct - channel
- string "label"
- string "name"
- string "parent_label"
- string "end_of_life"
- string "arch"
-
array:
-
struct - channel info
- int "id"
- string "label"
- string "name"
- string "provider_name"
- int "packages"
- int "systems"
- string "arch_name"
Namespace: channel.access
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
string - The access value (one of the following: 'public',
'private', or 'protected'.
-
int - 1 on success, exception thrown otherwise.
Namespace: channel.org
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - org
- int "org_id"
- string "org_name"
- boolean "access_enabled"
Namespace: channel.software
-
int - 1 on success, exception thrown otherwise.
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- 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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
int number of available subscriptions for the given channel
-
int the cloned channel ID
-
int - 1 if the creation operation succeeded, 0 otherwise
Available since: 10.9
-
int - 1 if the creation operation succeeded, 0 otherwise
Available since: 10.9
-
int - 1 if the creation operation succeeded, 0 otherwise
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
int - 1 on success, exception thrown otherwise.
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- 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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
the last build date of the repomd.xml file
as a localised string
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- 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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- 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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
string quartz expression
-
int - 1 if true, 0 otherwise
-
int - 1 if manageable, 0 if not
-
int - 1 if subscribable, 0 if not
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "checksum"
- string "checksum_type"
- int "id"
- string "arch_label"
- string "last_modified_date"
- string "last_modified" - (Deprecated)
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "checksum"
- string "checksum_type"
- int "id"
- string "arch_label"
- string "last_modified_date"
- string "last_modified" - (Deprecated)
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "checksum"
- string "checksum_type"
- int "id"
- string "arch_label"
- string "last_modified_date"
- string "last_modified" - (Deprecated)
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "checksum"
- string "checksum_type"
- int "id"
- string "arch_label"
- string "last_modified_date"
- string "last_modified" - (Deprecated)
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "checksum"
- string "checksum_type"
- int "id"
- string "arch_label"
- string "last_modified_date"
- string "last_modified" - (Deprecated)
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "id"
- string "arch_label"
- string "last_modified"
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "id"
- string "arch_label"
- string "last_modified"
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- string "id"
- string "arch_label"
- string "last_modified"
-
array:
-
struct - channel arch
- string "name"
- string "label"
-
array:
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
array:
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- 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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
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
-
array:
-
struct - errata
- int "id" - Errata Id
- 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 "advisory" - name of the advisory (Deprecated)
- string "issue_date" - date format follows YYYY-MM-DD HH24:MI:SS (Deprecated)
- string "update_date" - date format follows YYYY-MM-DD HH24:MI:SS (Deprecated)
- string "synopsis (Deprecated)"
- string "last_modified_date" - date format follows YYYY-MM-DD HH24:MI:SS (Deprecated)
-
array:
-
struct - errata
- string "advisory" - name of the advisory
- string "issue_date" - date format follows YYYY-MM-DD HH24:MI:SS
- string "update_date" - date format follows YYYY-MM-DD HH24:MI:SS
- string "synopsis"
- string "advisory_type"
- string "last_modified_date" - date format follows YYYY-MM-DD HH24:MI:SS
-
array:
-
struct - errata
- string "advisory" - name of the advisory
- string "issue_date" - date format follows YYYY-MM-DD HH24:MI:SS
- string "update_date" - date format follows YYYY-MM-DD HH24:MI:SS
- string "synopsis"
- string "advisory_type"
- string "last_modified_date" - date format follows YYYY-MM-DD HH24:MI:SS
-
array:
-
struct - errata
- string "advisory" - name of the advisory
- string "issue_date" - date format follows YYYY-MM-DD HH24:MI:SS
- string "update_date" - date format follows YYYY-MM-DD HH24:MI:SS
- string "synopsis"
- string "advisory_type"
- string "last_modified_date" - date format follows YYYY-MM-DD HH24:MI:SS
-
array:
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- int "id"
- string "arch_label"
-
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"
-
array:
-
struct - channel
- string "label"
- string "name"
-
array:
-
struct - map
- long "id" - ID of the repo
- string "label" - label of the repo
- string "sourceUrl" - URL of the repo
-
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.
-
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.
-
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.
-
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"
-
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.
-
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.
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
struct - channel
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
Namespace: configchannel
-
1 if exists, 0 otherwise.
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
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 - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
-
array:
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
-
array:
-
struct - Configuration File information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- dateTime.iso8601 "last_modified" - Last Modified Date
-
array:
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- string "type"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
array:
-
struct - system
- int "id"
- string "name"
-
array:
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
array:
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.12
-
int actionId - The action id of the scheduled action
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
Namespace: distchannel
-
struct - distChannelMap
- string "os" - Operationg System
- string "release" - OS Relase
- string "arch_label" - Channel architecture
- string "channel_label" - Channel label
-
int - 1 on success, exception thrown otherwise.
Namespace: errata
-
int - representing the number of packages added,
exception otherwise
-
array:
-
struct - channel
- int "channel_id"
- string "label"
- string "name"
- string "parent_channel_label"
-
struct - Bugzilla info
- string "bugzilla_id" - actual bug number is the key into the
struct
- string "bug_summary" - summary who's key is the bug id
-
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.
-
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.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
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.
-
int - 1 on success, exception thrown otherwise.
-
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.
-
struct - erratum
- string "issue_date"
- string "update_date"
- string "last_modified_date" - This date is only included for
published erratum and it represents the last time the erratum was
modified.
- string "synopsis"
- int "release"
- string "type"
- string "product"
- string "errataFrom"
- string "topic"
- string "description"
- string "references"
- string "notes"
- string "solution"
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
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.
-
array:
- string - cveName
-
array:
- string - Keyword associated with erratum.
-
array:
-
struct - package
- int "id"
- string "name"
- string "epoch"
- string "version"
- string "release"
- string "arch_label"
- array "providing_channels"
- string - Channel label
providing this package.
- string "build_host"
- string "description"
- string "checksum"
- string "checksum_type"
- string "vendor"
- string "summary"
- string "cookie"
- string "license"
- string "path"
- string "file"
- string "build_date"
- string "last_modified_date"
- string "size"
- string "payload_size"
-
array:
-
struct - erratum
- int "id"
- int "published"
- string "advisory"
- string "advisory_name"
- string "advisory_type"
- string "synopsis"
- dateTime.iso8601 "created"
- dateTime.iso8601 "update_date"
-
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.
-
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.
-
int - representing the number of packages removed,
exception otherwise
-
int - 1 on success, exception thrown otherwise.
Namespace: kickstart
-
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 - label of the kickstart. Empty string ("") if
not found.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
true if profile is disabled
-
array:
-
struct - Kickstart Ip Range
- string "ksLabel" - The kickstart label associated with the ip range
- string "max" - The max ip of the range
- string "min" - The min ip of the range
-
array:
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- 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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
array:
-
struct - kickstartable tree
- int "id"
- string "label"
- string "base_path"
- int "channel_id"
-
array:
-
struct - kickstart
- string "label"
- string "tree_label"
- string "name"
- boolean "advanced_mode"
- boolean "org_default"
- boolean "active"
-
int - 1 on success, exception thrown otherwise.
Namespace: kickstart.filepreservation
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - file list
- string "name"
- array "file_names"
- string name
-
array:
-
struct - file preservation
- int "id"
- string "name"
- dateTime.iso8601 "created"
- dateTime.iso8601 "last_modified"
Namespace: kickstart.keys
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - key
- string "description"
- string "type"
- string "content"
-
array:
-
struct - key
- string "description"
- string "type"
-
int - 1 on success, exception thrown otherwise.
Namespace: kickstart.profile
-
int - 1 on success, exception thrown otherwise.
-
int id - the id of the added script
-
int id - the id of the added script
-
struct - Comparison Info
- array "kickstartLabel1" - Actual label of the first kickstart
profile is the key into the struct
array:
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- string childChannelLabel
- array "entitlements"
- string entitlementLabel
- array "server_group_ids"
- string serverGroupId
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
- array "kickstartLabel2" - Actual label of the second kickstart
profile is the key into the struct
array:
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- string childChannelLabel
- array "entitlements"
- string entitlementLabel
- array "server_group_ids"
- string serverGroupId
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
-
struct - Comparison Info
- array "kickstartLabel1" - Actual label of the first kickstart
profile is the key into the struct
array:
-
struct - value
- string "name"
- string "value"
- boolean "enabled"
- array "kickstartLabel2" - Actual label of the second kickstart
profile is the key into the struct
array:
-
struct - value
- string "name"
- string "value"
- boolean "enabled"
-
struct - Comparison Info
- array "kickstartLabel1" - Actual label of the first kickstart
profile is the key into the struct
array:
- string - package name
- array "kickstartLabel2" - Actual label of the second kickstart
profile is the key into the struct
array:
- string - package name
-
string - The contents of the kickstart file. Note: if
an activation key is not associated with the kickstart file, registration
will not occur in the satellite generated %post section. If one is
associated, it will be used for registration.
-
string - The contents of the kickstart file.
-
array:
-
struct - option
- string "name"
- string "arguments"
-
boolean - The value of the option. True means that
ks.cfg will be copied to /root, false means that it will not.
-
array:
- string - channelLabel
-
array:
-
struct - option
- int "id"
- string "arguments"
-
string kstreeLabel - Label of the kickstart tree.
-
array:
-
struct - kickstart variable
- string "key"
- string or int "value"
-
array:
-
struct - Kickstart Ip Range
- string "ksLabel" - The kickstart label associated with the ip range
- string "max" - The max ip of the range
- string "min" - The min ip of the range
-
array:
-
struct - kickstart script
- int "id"
- string "contents"
- string "script_type" - Which type of script ('pre' or 'post').
- string "interpreter" - The scripting language interpreter to use
for this script. An empty string indicates the default kickstart
shell.
- boolean "chroot" - True if the script will be executed within the
chroot environment.
- boolean "template" - True if templating using cobbler is enabled
-
int - 1 on successful removal, 0 if range wasn't found
for the specified kickstart, exception 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.
-
int - 1 on success, exception thrown otherwise.
Namespace: kickstart.profile.keys
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- string childChannelLabel
- array "entitlements"
- string entitlementLabel
- array "server_group_ids"
- string serverGroupId
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
-
int - 1 on success, exception thrown otherwise.
Namespace: kickstart.profile.software
-
int - 1 on success, exception thrown otherwise.
-
string[] - Get a list of a kickstart profile's
software packages.
-
int - 1 on success, exception thrown otherwise.
Namespace: kickstart.profile.system
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
boolean enabled - true if configuration
management is enabled; otherwise, false
-
boolean enabled - true if remote
commands support is enabled; otherwise, false
-
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 - locale info
- string "locale"
- boolean "useUtc"
- true - the hardware clock uses UTC
- false - the hardware clock does not use UTC
-
string[] - A list of partitioning commands used to
setup the partitions, logical volumes and volume groups."
-
string registrationType
- reactivation
- deletion
- none
-
string enforcingMode
- enforcing
- permissive
- disabled
-
array:
-
struct - file list
- string "name"
- array "file_names"
- string name
-
array:
-
struct - key
- string "description"
- string "type"
- string "content"
-
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.
Namespace: kickstart.snippet
-
struct - snippet
- string "name"
- string "contents"
- string "fragment" - The string to include in a kickstart
file that will generate this snippet.
- string "file" - The local path to the file containing this snippet.
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - snippet
- string "name"
- string "contents"
- string "fragment" - The string to include in a kickstart
file that will generate this snippet.
- string "file" - The local path to the file containing this snippet.
-
array:
-
struct - snippet
- string "name"
- string "contents"
- string "fragment" - The string to include in a kickstart
file that will generate this snippet.
- string "file" - The local path to the file containing this snippet.
-
array:
-
struct - snippet
- string "name"
- string "contents"
- string "fragment" - The string to include in a kickstart
file that will generate this snippet.
- string "file" - The local path to the file containing this snippet.
Namespace: kickstart.tree
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - kickstartable tree
- int "id"
- string "label"
- string "abs_path"
- int "channel_id"
struct - kickstart install type
- int "id"
- string "label"
- string "name"
-
array:
-
struct - kickstartable tree
- int "id"
- string "label"
- string "base_path"
- int "channel_id"
-
array:
-
struct - kickstart install type
- int "id"
- string "label"
- string "name"
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
Namespace: org
-
struct - organization info
- int "id"
- string "name"
- int "active_users" - Number of active users in the organization.
- int "systems" - Number of systems in the organization.
- int "trusts" - Number of trusted organizations.
- int "system_groups" - Number of system groups in the organization. (optional)
- int "activation_keys" - Number of activation keys in the organization. (optional)
- int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
- int "configuration_channels" - Number of configuration channels in the organization. (optional)
-
int - 1 on success, exception thrown otherwise.
-
struct - organization info
- int "id"
- string "name"
- int "active_users" - Number of active users in the organization.
- int "systems" - Number of systems in the organization.
- int "trusts" - Number of trusted organizations.
- int "system_groups" - Number of system groups in the organization. (optional)
- int "activation_keys" - Number of activation keys in the organization. (optional)
- int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
- int "configuration_channels" - Number of configuration channels in the organization. (optional)
-
struct - organization info
- int "id"
- string "name"
- int "active_users" - Number of active users in the organization.
- int "systems" - Number of systems in the organization.
- int "trusts" - Number of trusted organizations.
- int "system_groups" - Number of system groups in the organization. (optional)
- int "activation_keys" - Number of activation keys in the organization. (optional)
- int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
- int "configuration_channels" - Number of configuration channels in the organization. (optional)
-
struct - organization info
- int "id"
- string "name"
- int "active_users" - Number of active users in the organization.
- int "systems" - Number of systems in the organization.
- int "trusts" - Number of trusted organizations.
- int "system_groups" - Number of system groups in the organization. (optional)
- int "activation_keys" - Number of activation keys in the organization. (optional)
- int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
- int "configuration_channels" - Number of configuration channels in the organization. (optional)
-
array:
-
struct - entitlement usage
- string "label"
- string "name"
- int "free"
- int "used"
- int "allocated"
- int "unallocated"
- int "free_flex"
- int "used_flex"
- int "allocated_flex"
- int "unallocated_flex"
-
array:
-
struct - entitlement usage
- int "org_id"
- string "org_name"
- int "allocated"
- int "unallocated"
- int "used"
- int "free"
-
array:
-
struct - entitlement usage
- int "org_id"
- string "org_name"
- int "allocated"
- int "unallocated"
- int "used"
- int "free"
Available since: 10.4
-
array:
-
struct - entitlement usage
- string "label"
- string "name"
- int "allocated"
- int "unallocated"
- int "free"
- int "used"
- int "allocated_flex"
- int "unallocated_flex"
- int "free_flex"
- int "used_flex"
-
array:
-
struct - entitlement usage
- string "label"
- string "name"
- int "free"
- int "used"
- int "allocated"
- int "unallocated"
- int "free_flex"
- int "used_flex"
- int "allocated_flex"
- int "unallocated_flex"
-
array:
-
struct - entitlement usage
- int "org_id"
- string "org_name"
- int "allocated"
- int "unallocated"
- int "used"
- int "free"
-
array:
-
struct - entitlement usage
- int "org_id"
- string "org_name"
- int "allocated"
- int "unallocated"
- int "used"
- int "free"
Available since: 10.4
-
array:
-
struct - entitlement usage
- string "label"
- string "name"
- int "free"
- int "used"
- int "allocated"
- int "unallocated"
-
array:
-
struct - user
- string "login"
- string "login_uc"
- string "name"
- string "email"
- boolean "is_org_admin"
-
array:
- int - serverIdMigrated
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - organization info
- int "id"
- string "name"
- int "active_users" - Number of active users in the organization.
- int "systems" - Number of systems in the organization.
- int "trusts" - Number of trusted organizations.
- int "system_groups" - Number of system groups in the organization. (optional)
- int "activation_keys" - Number of activation keys in the organization. (optional)
- int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
- int "configuration_channels" - Number of configuration channels in the organization. (optional)
Namespace: org.trusts
-
int - 1 on success, exception thrown otherwise.
-
struct - org trust details
- dateTime.iso8601 "created" - Date the organization was
created
- dateTime.iso8601 "trusted_since" - Date the organization was
defined as trusted
- int "channels_provided" - Number of channels provided by
the organization.
- int "channels_consumed" - Number of channels consumed by
the organization.
- int "systems_migrated_to" - Number of systems migrated to
the organization.
- int "systems_migrated_from" - Number of systems migrated
from the organization.
-
array:
-
struct - channel info
- int "channel_id"
- string "channel_name"
- int "packages"
- int "systems"
-
array:
-
struct - channel info
- int "channel_id"
- string "channel_name"
- int "packages"
- int "systems"
-
array:
-
struct - trusted organizations
- int "org_id"
- string "org_name"
- int "shared_channels"
-
array:
-
struct - affected systems
- int "systemId"
- string "systemName"
-
array:
-
struct - trusted organizations
- int "orgId"
- string "orgName"
- bool "trustEnabled"
-
int - 1 on success, exception thrown otherwise.
Namespace: packages
-
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"
-
struct - package
- int "id"
- string "name"
- string "epoch"
- string "version"
- string "release"
- string "arch_label"
- array "providing_channels"
- string Channel label providing this package.
- string "build_host"
- string "description"
- string "checksum"
- string "checksum_type"
- string "vendor"
- string "summary"
- string "cookie"
- string "license"
- string "file"
- string "build_date"
- string "last_modified_date"
- string "size"
- string "path" - The path on the Satellite's file system that
the package resides.
- string "payload_size"
-
base64 - base64 encoded package
-
string - the download url
-
string
-
array:
-
struct - dependency
- string "dependency"
- string "dependency_type" - One of the following:
- requires
- conflicts
- obsoletes
- provides
- string "dependency_modifier"
-
array:
-
struct - file info
- string "path"
- string "type"
- string "last_modified_date"
- string "checksum"
- string "checksum_type"
- int "size"
- string "linkto"
-
array:
-
struct - channel
- string "label"
- string "parent_label"
- string "name"
-
array:
-
struct - errata
- string "advisory"
- string "issue_date"
- string "last_modified_date"
- string "update_date"
- string "synopsis"
- string "type"
-
int - 1 on success, exception thrown otherwise.
Namespace: packages.provider
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - package provider
- string "name"
- array "keys"
-
struct - package security key
- string "key"
- string "type"
-
array:
-
struct - package security key
- string "key"
- string "type"
Namespace: packages.search
-
array:
-
struct - package overview
- int "id"
- string "name"
- string "summary"
- string "description"
- string "version"
- string "release"
- string "arch"
- string "epoch"
- string "provider"
-
array:
-
struct - package overview
- int "id"
- string "name"
- string "summary"
- string "description"
- string "version"
- string "release"
- string "arch"
- string "epoch"
- string "provider"
-
array:
-
struct - package overview
- int "id"
- string "name"
- string "summary"
- string "description"
- string "version"
- string "release"
- string "arch"
- string "epoch"
- string "provider"
-
array:
-
struct - package overview
- int "id"
- string "name"
- string "summary"
- string "description"
- string "version"
- string "release"
- string "arch"
- string "epoch"
- string "provider"
-
array:
-
struct - package overview
- int "id"
- string "name"
- string "summary"
- string "description"
- string "version"
- string "release"
- string "arch"
- string "epoch"
- string "provider"
-
array:
-
struct - package overview
- int "id"
- string "name"
- string "summary"
- string "description"
- string "version"
- string "release"
- string "arch"
- string "epoch"
- string "provider"
Namespace: preferences.locale
-
array:
- string - Locale code.
-
array:
-
struct - timezone
- int "time_zone_id" - Unique identifier for timezone.
- string "olson_name" - Name as identified by the Olson database.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
Namespace: proxy
-
int - 1 on success, exception thrown otherwise.
-
string
Available since: 10.7
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
- string - version
Available since: 10.5
Namespace: satellite
-
dateTime.iso8601
-
boolean True if monitoring is enabled
-
boolean True if monitoring is enabled
-
struct - channel/system entitlements
- array "system"
-
struct - system entitlement
- string "label"
- string "name"
- int "used_slots"
- int "free_slots"
- int "total_slots"
- array "channel"
-
struct - channel entitlement
- string "label"
- string "name"
- int "used_slots"
- int "free_slots"
- int "total_slots"
- int "used_flex"
- int "free_flex"
- int "total_flex"
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
Namespace: schedule
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - action
- int "id" - Action Id.
- string "name" - Action name.
- string "type" - Action type.
- string "scheduler" - The user that scheduled the action. (optional)
- dateTime.iso8601 "earliest" - The earliest date and time the action
will be performed
- int "completedSystems" - Number of systems that completed the action.
- int "failedSystems" - Number of systems that failed the action.
- int "inProgressSystems" - Number of systems that are in progress.
-
array:
-
struct - action
- int "id" - Action Id.
- string "name" - Action name.
- string "type" - Action type.
- string "scheduler" - The user that scheduled the action. (optional)
- dateTime.iso8601 "earliest" - The earliest date and time the action
will be performed
- int "completedSystems" - Number of systems that completed the action.
- int "failedSystems" - Number of systems that failed the action.
- int "inProgressSystems" - Number of systems that are in progress.
-
array:
-
struct - action
- int "id" - Action Id.
- string "name" - Action name.
- string "type" - Action type.
- string "scheduler" - The user that scheduled the action. (optional)
- dateTime.iso8601 "earliest" - The earliest date and time the action
will be performed
- int "completedSystems" - Number of systems that completed the action.
- int "failedSystems" - Number of systems that failed the action.
- int "inProgressSystems" - Number of systems that are in progress.
-
array:
-
struct - system
- int "server_id"
- string "server_name" - Server name.
- string "base_channel" - Base channel used by the server.
- dateTime.iso8601 "timestamp" - The time the action was completed
- string "message" - Optional message containing details
on the execution of the action. For example, if the action failed,
this will contain the failure text.
-
array:
-
struct - action
- int "id" - Action Id.
- string "name" - Action name.
- string "type" - Action type.
- string "scheduler" - The user that scheduled the action. (optional)
- dateTime.iso8601 "earliest" - The earliest date and time the action
will be performed
- int "completedSystems" - Number of systems that completed the action.
- int "failedSystems" - Number of systems that failed the action.
- int "inProgressSystems" - Number of systems that are in progress.
-
array:
-
struct - system
- int "server_id"
- string "server_name" - Server name.
- string "base_channel" - Base channel used by the server.
- dateTime.iso8601 "timestamp" - The time the action was completed
- string "message" - Optional message containing details
on the execution of the action. For example, if the action failed,
this will contain the failure text.
-
array:
-
struct - action
- int "id" - Action Id.
- string "name" - Action name.
- string "type" - Action type.
- string "scheduler" - The user that scheduled the action. (optional)
- dateTime.iso8601 "earliest" - The earliest date and time the action
will be performed
- int "completedSystems" - Number of systems that completed the action.
- int "failedSystems" - Number of systems that failed the action.
- int "inProgressSystems" - Number of systems that are in progress.
-
array:
-
struct - system
- int "server_id"
- string "server_name" - Server name.
- string "base_channel" - Base channel used by the server.
- dateTime.iso8601 "timestamp" - The time the action was completed
- string "message" - Optional message containing details
on the execution of the action. For example, if the action failed,
this will contain the failure text.
-
int - 1 on success, exception thrown otherwise.
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_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_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 - the total the number of systems
that were converted to use flex entitlement.
-
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.
Available since: 10.10
-
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"
-
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.
(enterprise_entitled or sw_mgr_entitled)
- array "string"
- addon_entitlements System's addon entitlements labels,
including monitoring_entitled, provisioning_entitled,
virtualization_host, virtualization_host_platform
- 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.
-
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
-
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
-
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
- result
-
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 "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"
- 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"
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
- string - key
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
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
-
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 "id"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - Duplicate Group
- string "ip"
- array "systems"
-
struct - system
- int "id"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - Duplicate Group
- string "mac"
- array "systems"
-
struct - system
- int "id"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - channel family system group
- int "id"
- string "label"
- string "name"
array:
- int - systems
-
array:
-
struct - channel family system group
- int "id"
- string "label"
- string "name"
array:
- int - systems
-
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
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
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"
-
struct - package
- string "name"
- string "version"
- string "release"
- string "epoch"
- int "id"
- string "arch_label"
-
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
- 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
-
array:
-
struct - package profile
- int "id"
- string "name"
- string "channel"
-
array:
-
struct - package
- int "id"
- 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 - 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 "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"
- string "end_of_life"
- string "parent_channel_label"
- string "clone_original"
array:
-
struct - contentSources
- int "id"
- string "label"
- string "sourceUrl"
- string "type"
-
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.
Available since: 10.8
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - system
- int "id" - server id
- string "name"
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
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
-
string
-
string
Available since: 10.10
-
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.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
Available since: 10.6
-
int - 1 on success, exception thrown otherwise.
-
int actionId - The action id of the scheduled action
-
int actionId - The action id of the scheduled action
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
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 - 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 - 1 on success, exception thrown otherwise.
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
-
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.
-
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
Namespace: system.config
-
int - 1 on success, exception thrown otherwise.
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
-
array:
-
struct - Configuration File information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "channel_label" - the label of the central configuration channel
that has this file. Note this entry only shows up
if the file has not been overridden by a central channel.
- struct "channel_type"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
- dateTime.iso8601 "last_modified" - Last Modified Date
-
array:
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
Namespace: system.custominfo
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
array:
-
struct - custom info
- int "id"
- string "label"
- string "description"
- int "system_count"
- dateTime.iso8601 "last_modified"
-
int - 1 on success, exception thrown otherwise.
Namespace: system.provisioning.snapshot
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
Available since: 10.1
-
int - 1 on success, exception thrown otherwise.
Available since: 10.1
-
int - 1 on success, exception thrown otherwise.
Available since: 10.1
-
array:
-
struct - Configuration Revision information
- string "type"
- file
- directory
- symlink
- string "path" - File Path
- string "target_path" - Symbolic link Target File Path.
Present for Symbolic links only.
- string "channel" - Channel Name
- string "contents" - File contents (base64 encoded according
to the contents_enc64 attribute)
- boolean "contents_enc64" - Identifies base64 encoded content
- int "revision" - File Revision
- dateTime.iso8601 "creation" - Creation Date
- dateTime.iso8601 "modified" - Last Modified Date
- string "owner" - File Owner. Present for files or directories only.
- string "group" - File Group. Present for files or directories only.
- int "permissions" - File Permissions (Deprecated).
Present for files or directories only.
- string "permissions_mode" - File Permissions.
Present for files or directories only.
- string "selinux_ctx" - SELinux Context (optional).
- boolean "binary" - true/false , Present for files only.
- string "md5" - File's md5 signature. Present for files only.
- string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.
- string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.
Available since: 10.2
-
array:
-
struct - package nvera
- string "name"
- string "epoch"
- string "version"
- string "release"
- string "arch"
Available since: 10.1
-
array:
-
struct - server snapshot
- int "id"
- string "reason" - the reason for the snapshot's existence
- dateTime.iso8601 "created"
- array "channels"
- string labels of channels associated with the
snapshot
- array "groups"
- string Names of server groups associated with
the snapshot
- array "entitlements"
- string Names of system entitlements associated
with the snapshot
- array "config_channels"
- string Labels of config channels the snapshot
is associated with.
- array "tags"
- string Tag names associated with this snapshot.
- string "Invalid_reason" - If the snapshot is invalid, this is the
reason (optional).
Available since: 10.1
Namespace: system.scap
-
struct - OpenSCAP XCCDF Scan
- int "xid" - XCCDF TestResult id
- int "sid" - serverId
- int "action_id" - Id of the parent action.
- string "path" - Path to XCCDF document
- string "oscap_parameters" - oscap command-line arguments.
- string "test_result" - Identifier of XCCDF TestResult.
- string "benchmark" - Identifier of XCCDF Benchmark.
- string "benchmark_version" - Version of the Benchmark.
- string "profile" - Identifier of XCCDF Profile.
- string "profile_title" - Title of XCCDF Profile.
- dateTime.iso8601 "start_time" - Client machine time of scan start.
- dateTime.iso8601 "end_time" - Client machine time of scan completion.
- string "errors" - Stderr output of scan.
-
array:
-
struct - OpenSCAP XCCDF RuleResult
- string "idref" - idref from XCCDF document.
- string "result" - Result of evaluation.
- string "idents" - Comma separated list of XCCDF idents.
-
array:
-
struct - OpenSCAP XCCDF Scan
- int "xid" - XCCDF TestResult ID
- string "profile" - XCCDF Profile
- string "path" - Path to XCCDF document
- dateTime.iso8601 "completed" - Scan completion time
-
int - ID if SCAP action created.
-
int - ID if SCAP action created.
-
int - ID of the scap action created.
-
int - ID of the scap action created.
Namespace: system.search
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
-
array:
-
struct - system
- int "id"
- string "name"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
- string "hostname"
- string "ip"
- string "hw_description" - hw description if not null
- string "hw_device_id" - hw device id if not null
- string "hw_vendor_id" - hw vendor id if not null
- string "hw_driver" - hw driver if not null
Namespace: systemgroup
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - Server Group
- int "id"
- string "name"
- string "description"
- int "org_id"
- int "system_count"
-
int - 1 on success, exception thrown otherwise.
-
struct - Server Group
- int "id"
- string "name"
- string "description"
- int "org_id"
- int "system_count"
-
struct - Server Group
- int "id"
- string "name"
- string "description"
- int "org_id"
- int "system_count"
-
array:
- int - server_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
-
array:
-
struct - Server Group
- int "id"
- string "name"
- string "description"
- int "org_id"
- int "system_count"
-
array:
-
struct - Server Group
- int "id"
- string "name"
- string "description"
- int "org_id"
- int "system_count"
-
array:
- int - server_id
-
array:
- int - server_id
-
array:
-
struct - server details
- int "id" - System id
- string "profile_name"
- string "base_entitlement" - System's base entitlement label.
(enterprise_entitled or sw_mgr_entitled)
- array "string"
- addon_entitlements System's addon entitlements labels,
including monitoring_entitled, provisioning_entitled,
virtualization_host, virtualization_host_platform
- 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.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - Server Group
- int "id"
- string "name"
- string "description"
- int "org_id"
- int "system_count"
Namespace: user
-
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.
-
int - 1 on success, exception thrown otherwise.
-
int - 1 on success, exception thrown otherwise.
-
struct - user details
- string "first_names" - deprecated, use first_name
- string "first_name"
- string "last_name"
- string "email"
- int "org_id"
- string "prefix"
- string "last_login_date"
- string "created_date"
- boolean "enabled" - true if user is enabled,
false if the user is disabled
- boolean "use_pam" - true if user is configured to use
PAM authentication
-
dateTime.iso8601
-
array:
- string - (role label)
-
array:
-
struct - system group
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id" - Organization ID for this system group.
-
array:
-
struct - system group
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id" - Organization ID for this system group.
-
array:
- string - (role label)
-
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
-
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.