Red Hat Training
A Red Hat training course is available for Red Hat Satellite
API ガイド
Red Hat Satellite 5.8
Red Hat Satellite API のリファレンスガイド
Red Hat Satellite Documentation Team
satellite-doc-list@redhat.com
概要
本ガイドは、Red Hat Satellite の XML-RPC API についてのガイドで、使用法の例を紹介しています。
第1章 Red Hat Satellite について
Red Hat Satellite は、サーバーやクライアントシステムが公開インターネットにアクセスすることなく、Red Hat Network の利点を組織に提供することができます。Red Hat Satellite には、以下のような利点があります。
このため、Red Hat Network をご利用のお客様には、サーバーの安全性を確保しながら最新の状態を保てるよう最大限の柔軟性と機能が提供されます。
- 独自のネットワーク内で、パッケージ管理やサーバーのメンテナンスにおけるプライバシーと完全なコントロールを保つことができます。
- Satellite サーバーにシステムプロファイルを保存し、このサーバーがローカルの Web サーバーを利用して Red Hat Network web サイトに接続できます。
- エラータ更新などパッケージ管理作業をローカルエリアネットワーク (LAN) で実施できます。
1.1. Red Hat Satellite API
Red Hat Satellite は API を提供し、これにより、ソフトウェア開発者やシステム管理者は、標準の Web やコマンドラインインターフェース以外で Satellite サーバーを制御できます。この API は、Red Hat Satellite の機能と、XML リモート プロシージャ コール (RPC) プロトコルや XML-RPC で API にアクセスする外部アプリケーションやカスタムスクリプトと統合することを目指している開発者や管理者には有用です。
本ガイドでは、開発者および管理者を対象に、XML-RPM プロトコルによる Red Hat Satellite の機能の利用方法の手順と実例を記載しています。
1.2. XML-RPC を使った Red Hat Satellite API
XML-RPC は HTTP を使って XML でエンコードされたリクエストをサーバーに送信します。リクエストには以下のものが含まれます。
- 名前空間
- 名前空間は、特定の関数、オブジェクト、またはリソースに基づくメソッドをグループ化したものです。たとえば、
auth
名前空間では認証関数をグループ化しており、errata
名前空間ではエラータを制御する関数をグループ化しています。 - メソッド
- メソッドは、特定のアクションを表します。各メソッドは、Red Hat Satellite の特定関数を制御します。たとえば、
auth
名前空間内のlogin
メソッドは、ユーザーを Red Hat Satellite にログインさせて、セッションキーを返します。 - パラメーター
- パラメーターは、メソッドの特定の側面を制御するための入力です。たとえば、たとえば、
auth
名前空間内のlogin
メソッドで特定ユーザーのログイン詳細を特定するには、username
とpassword
というパラメーターが必要になります。login
メソッドではオプションのduration
パラメーターを使って、ユーザーのセッションが終了するまでの時間を特定することもできます。
XML でエンコードされたリクエストは通常、以下のような構造になります。
<methodCall> <methodName>namespace.method</methodName> <params> <param> <value><name>parameter</name></value> </param> <param> <value><name>parameter</name></value> </param> ... </params> </methodCall>
たとえば、API にログインして認証用にセッションキーを要求するには、以下の XML-RPC リクエストを使用します。
<methodCall> <methodName>auth.login</methodName> <params> <param> <value><username>admin</username></value> </param> <param> <value><password>p@55w0rd!</password></value> </param> </params> </methodCall>
この例では、リクエストが
username
と password
をパラメーターとして login
メソッドに送信します。このメソッドは auth
名前空間の一部になります。Satellite サーバーは以下の応答を返します。
<methodResponse> <params> <param> <value><sessionKey>83d8b35f</sessionKey></value> </param> </params> </methodResponse>
この応答には、
sessionKey
に返されたパラメーターが含まれており、このキーを使ってほとんどの API メソッドを認証します。
ほとんどのプログラミング言語には XML-RPC モジュールおよびライブラリーが含まれており、これらが自動的に使用されるメソッドとパラメーターを XML でエンコードされたリクエストに解析し、その応答を返された変数として解析します。例については、2章例 を参照してください。
XML-RPC についての詳細情報は、http://www.xmlrpc.com/ を参照してください。
1.3. 読み取り専用 API の使用
Red Hat Satellite 5.8 には読み取り専用 API があり、これは Satellite サーバーのコンテンツレポートを安全に監査、生成するように設計されています。読み取り専用ユーザーは、Satellite web UI にログインしたり、Satellite の機能に影響を及ぼす他のアクションを実行することができません。たとえば、読み取り専用ユーザーは、バックエンドコールを作成したり、コンテンツを修正する API コールを使用することができません。
読み取り専用 API ユーザーが使用できるのは、
org.listUsers
などの非破壊的 API コールのみです。つまり、list
、is
、または get
で始まらない API コール にはアクセスできません。さらに、読み取り専用ユーザーがロールに関連付けられている API コールにアクセスするには、通常のユーザーと同じロール指定が必要になります。このため、読み取り専用チャネルの管理者は channel.listAllChannels
のような API コールは実行できるものの、組織管理者の権限がないため org.listUsers
は呼び出せないということになります。
1.3.1. 読み取り専用ユーザーの作成
読み取り専用ユーザーは他のタイプのユーザーと同じ方法で作成しますが、作成プロセスで Read only API user を選択する必要があります。
手順1.1 読み取り専用 API ユーザーの作成方法:
- メインメニューの ユーザー タブをクリックし、ユーザーの作成をクリックします。
- 必要な詳細を入力し、Read-only API User を選択します。
- ログインの作成 をクリックします。
第2章 例
以下のセクションでは、プログラミング言語とそれらの XML-RPC リクエストを利用した Red Hat Satellite API の使用例を表示しています。
2.1. Python の例
以下は
user.listUsers
コールの例です。ここでは、各グループの名前をプリントします。
#!/usr/bin/python import xmlrpclib SATELLITE_URL = "http://satellite.example.com/rpc/api" SATELLITE_LOGIN = "username" SATELLITE_PASSWORD = "password" client = xmlrpclib.Server(SATELLITE_URL, verbose=0) key = client.auth.login(SATELLITE_LOGIN, SATELLITE_PASSWORD) list = client.user.list_users(key) for user in list: print user.get('login') client.auth.logout(key)
以下の例では、date-time パラメーターの使い方を示しています。このコードでは、ID が
1000000001
のシステムに rhnlib-2.5.22.9.el6.noarch パッケージをインストールすることをスケジュールします。
#!/usr/bin/python from datetime import datetime import time import xmlrpclib SATELLITE_URL = "http://satellite.example.com/rpc/api" SATELLITE_LOGIN = "username" SATELLITE_PASSWORD = "password" client = xmlrpclib.Server(SATELLITE_URL, verbose=0) key = client.auth.login(SATELLITE_LOGIN, SATELLITE_PASSWORD) package_list = client.packages.findByNvrea(key, 'rhnlib', '2.5.22', '9.el6', '', 'noarch') today = datetime.today() earliest_occurrence = xmlrpclib.DateTime(today) client.system.schedulePackageInstall(key, 1000000001, package_list[0]['id'], earliest_occurrence) client.auth.logout(key)
以下の例では、チャネルにおける最新の同期を確認する方法を示しています。
#!/usr/bin/python import xmlrpclib SATELLITE_URL = "http://sat57.example.com/rpc/api" SATELLITE_LOGIN = "admin" SATELLITE_PASSWORD = "Redhat123" client = xmlrpclib.Server(SATELLITE_URL, verbose=0) key = client.auth.login(SATELLITE_LOGIN, SATELLITE_PASSWORD) list = client.channel.listAllChannels(key) for item in list: details = client.channel.software.getDetails(key, item['label']) print item print details print "Name: " + details['name'] try: print "Last Sync: " + details['yumrepo_last_sync'] except: print "Last Sync: Never" client.auth.logout(key)
2.2. Perl の例
以下の例では、
system.listUserSystems
コールを使って、ユーザーがアクセスできるシステム一覧を取得しています。この例では、各システム名をプリントします。Frontier::Client
Perl モジュールは、perl-Frontier-RPC
RPM ファイル内にあります。
#!/usr/bin/perl use Frontier::Client; my $HOST = 'satellite.example.com'; my $user = 'username'; my $pass = 'password'; my $client = new Frontier::Client(url => "http://$HOST/rpc/api"); my $session = $client->call('auth.login',$user, $pass); my $systems = $client->call('system.listUserSystems', $session); foreach my $system (@$systems) { print $system->{'name'}."\n"; } $client->call('auth.logout', $session);
2.3. Ruby の例
以下は
channel.listAllChannels
API コールの例です。この例ではチャネルラベル一覧をプリントします。
#!/usr/bin/env ruby require "xmlrpc/client" @SATELLITE_URL = "http://satellite.example.com/rpc/api" @SATELLITE_LOGIN = "username" @SATELLITE_PASSWORD = "password" @client = XMLRPC::Client.new2(@SATELLITE_URL) @key = @client.call('auth.login', @SATELLITE_LOGIN, @SATELLITE_PASSWORD) channels = @client.call('channel.listAllChannels', @key) for channel in channels do p channel["label"] end @client.call('auth.logout', @key)
パート I. メソッド
第3章 actionchain
概要
Action Chain メソッドに名前空間を提供します。
3.1. addConfigurationDeployment
- 名前
- addConfigurationDeployment
- 説明
- Action Chain に設定ファイルをデプロイするアクションを追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string chainLabel - chain のラベル
- int System ID - システム ID
- array:
- int - 改訂 ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
3.2. addErrataUpdate
- 名前
- addErrataUpdate
- 説明
- Action Chain にエラータ更新を追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId - システム ID
- array:
- int - エラータ ID
- string chainLabel - chain のラベル
- 戻り値
- int actionId - 予定されるアクションのアクション ID
3.3. addPackageInstall
- 名前
- addPackageInstall
- 説明
- Action Chain にパッケージインストールのアクションを追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId - システム ID
- array:
- int - パッケージ ID
- string chainLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
3.4. addPackageRemoval
- 名前
- addPackageRemoval
- 説明
- Action Chain に、システム上にインストール済みのパッケージを削除するアクションを追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId - システム ID
- array:
- int - パッケージ ID
- string chainLabel - chain のラベル
- 戻り値
- int actionId - 予定されるアクションまたは例外のアクション ID
3.5. addPackageUpgrade
- 名前
- addPackageUpgrade
- 説明
- Action Chain に、システム上にインストール済みのパッケージをアップグレードするアクションを追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId - システム ID
- array:
- int - packageId
- string chainLabel - chain のラベル
- 戻り値
- int actionId - アクションまたは例外のスローの ID
3.6. addPackageVerify
- 名前
- addPackageVerify
- 説明
- Action Chain に、システム上にインストール済みのパッケージを検証するアクションを追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId - システム ID
- array:
- int - packageId
- string chainLabel - chain のラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
3.7. addScriptRun
- 名前
- addScriptRun
- 説明
- スクリプトを実行するアクションを Action Chain に追加します。注記: スクリプトのボディは Base64 でエンコードされている必要があります!
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId - システム ID
- string chainLabel - chain のラベル
- string uid - 特定システム上のユーザー ID
- string gid - 特定システム上のグループ ID
- int timeout - タイムアウト
- string scriptBodyBase64 - Base64 でエンコードされたスクリプトのボディ
- 戻り値
- int actionId - アクションまたは例外のスローの ID
3.8. addSystemReboot
- 名前
- addSystemReboot
- 説明
- Action Chain にシステム再起動を追加します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- int serverId
- string chainLabel - chain のラベル
- 戻り値
- int actionId - 予定されるアクションのアクション ID
3.9. createChain
- 名前
- createChain
- 説明
- Action Chain を作成します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string chainLabel - chain のラベル
- 戻り値
- int actionId - 作成される action chain の ID
3.10. deleteChain
- 名前
- deleteChain
- 説明
- ラベルごとに action chain を削除します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string chainLabel - chain のラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
3.11. listChainActions
- 名前
- listChainActions
- 説明
- 特定の Action Chain 内の全アクションを一覧表示します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string chainLabel - chain のラベル
- 戻り値
- array:
- struct - entry
- int
id
- アクション ID - string
label
- アクションのラベル - string
created
- 作成日時 - string
earliest
- 予定される日時で最も早いもの - string
type
- アクションのタイプ - string
modified
- 修正日時 - string
cuid
- 作成者の UID
3.12. listChains
- 名前
- listChains
- 説明
- 現在利用可能な action chain を一覧表示します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- 戻り値
- array:
- struct - chain
- string
label
- Action Chain のラベル - string
entrycount
- Action Chain 内のエントリー数
3.13. removeAction
- 名前
- removeAction
- 説明
- Action Chain からアクションを削除します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string chainLabel - chain のラベル
- int actionId - アクション ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
3.14. renameChain
- 名前
- renameChain
- 説明
- Action Chain の名前を変更します。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string previousLabel - 以前の chain ラベル
- string newLabel - 新規 chain ラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
3.15. scheduleChain
- 名前
- scheduleChain
- 説明
- Action Chain をスケジュールして、アクションが実際に実行されるようにします。
- パラメーター
- string sessionKey - ログイン時に発行されるセッショントークン
- string chainLabel - chain のラベル
- dateTime.iso8601 最も早い日付
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第4章 activationkey
概要
web インターフェイスから利用可能な一般的なアクティベーションキー機能にアクセスするメソッドが含まれています。
4.1. addChildChannels
- 名前
- addChildChannels
- 説明
- 子チャンネルをアクティベーションキーに追加します。
- パラメーター
- string sessionKey
- string key
- array:
- string - childChannelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.2. addConfigChannels
- 名前
- addConfigChannels
- 説明
- アクティベーションキーと設定チャンネルの一覧がある場合、このメソッドはその設定チャンネルをアクティベーションキーの設定チャンネルの一番上または一番下 (どちらか指定した方) に追加します。追加リストで提供されている設定チャンネルの順序は、追加の際にも維持されます。追加リストにある設定チャンネルのいずれかが既にアクティベーションキーに存在する場合は、設定チャンネルは適切な場所に順位付けされます。
- パラメーター
- string sessionKey
- array:
- string - activationKey
- array:
- string - 順位どおりの設定チャンネルラベルの一覧
- boolean addToTop
- true - 指定されたチャンネルをアクティベーションキーの設定チャンネルリストの最初に追加します
- false - 指定されたチャンネルをアクティベーションキーの設定チャンネルリストの最後に追加します
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.3. addEntitlements
- 名前
- addEntitlements
- 説明
- アクティベーションキーにエンタイトルメントを追加します。現行では、アドオンエンタイトルメントのみが許可されています。(provisioning_entitled、virtualization_host、virtualization_host_platform)
- パラメーター
- string sessionKey
- string key
- array string - entitlement label
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.4. addPackageNames
- 名前
- addPackageNames
- 説明
- パッケージ名のみを使用して、パッケージをアクティベーションキーに追加します。廃止予定 - addPackages(string sessionKey、string key、array[packages]) に置換されます。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- string key
- array:
- string - packageName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.5. addPackages
- 名前
- addPackages
- 説明
- アクティベーションキーにパッケージを追加します。
- パラメーター
- string sessionKey
- string key
- array:
- struct - packages
- string
name
- パッケージ名 - string
arch
- Arch ラベル - オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.6. addServerGroups
- 名前
- addServerGroups
- 説明
- アクティベーションキーにサーバーグループを追加します。
- パラメーター
- string sessionKey
- string key
- array:
- int - serverGroupId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.7. checkConfigDeployment
- 名前
- checkConfigDeployment
- 説明
- 指定したアクティベーションキーについて設定ファイルのデプロイメントステータスを確認します。
- パラメーター
- string sessionKey
- string key
- 戻り値
- 有効な場合は 1、無効な場合は 0、それ以外は exception thrown。
4.8. clone
- 名前
- clone
- 説明
- 既存のアクティベーションキーをクローンします。
- パラメーター
- string sessionKey
- string key - クローンするキー。
- string cloneDescription - クローンするキーの説明。
- 戻り値
- string - 新規アクティベーションキー。
4.9. create
- 名前
- create
- 説明
- 新規アクティベーションキーを作成します。渡されるアクティベーションキーパラメーターには組織 ID の接頭辞が付けられ、この値は create コールで返されます。たとえば、呼び出し元がキー "foo" を渡して、ID が 100 の組織に所属している場合、実際のアクティベーションキーは "100-foo" になります。このコールでは、このアクティベーションキーの使用制限を設定できます。無制限の使用が望ましい場合は、使用制限引数なしの同様の名前の API メソッドを参照してください。
- パラメーター
- string sessionKey
- string key - 新規キーを自動生成するために空にしておきます。
- string description
- string baseChannelLabel - デフォルトを受け付けるために空にしておきます。
- int usageLimit - 無制限の使用が望ましい場合は、パラメーターを含まない create API を使用します。
- array string - キーに関連付けるアドオンエンタイトルメントのラベル。
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- boolean universalDefault
- 戻り値
- string - 新規アクティベーションキー。
4.10. create
- 名前
- create
- 説明
- 無制限の使用で新規アクティベーションキーを作成します。渡されるアクティベーションキーパラメーターには組織 ID の接頭辞が付けられ、この値は create コールで返されます。たとえば、呼び出し元がキー "foo" を渡して、ID が 100 の組織に所属している場合、実際のアクティベーションキーは "100-foo" になります。
- パラメーター
- string sessionKey
- string key - 新規キーを自動生成するために空にしておきます。
- string description
- string baseChannelLabel - デフォルトを受け付けるために空にしておきます。
- array string - キーに関連付けるアドオンエンタイトルメントのラベル。
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- boolean universalDefault
- 戻り値
- string - 新規アクティベーションキー。
4.11. delete
- 名前
- delete
- 説明
- アクティベーションキーを削除します。
- パラメーター
- string sessionKey
- string key
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.12. disableConfigDeployment
- 名前
- disableConfigDeployment
- 説明
- 指定したアクティベーションキーの設定ファイルのデプロイメントを無効にします。
- パラメーター
- string sessionKey
- string key
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.13. enableConfigDeployment
- 名前
- enableConfigDeployment
- 説明
- 指定したアクティベーションキーの設定ファイルのデプロイメントを有効にします。
- パラメーター
- string sessionKey
- string key
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.14. getDetails
- 名前
- getDetails
- 説明
- アクティベーションキーの詳細をルックアップします。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- string key
- 戻り値
- 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 - (パッケージで置換される予定)
- array
packages
- struct - package
- string
name
- packageName - string
arch
- archLabel - オプション
- boolean
universal_default
- boolean
disabled
4.15. listActivatedSystems
- 名前
- listActivatedSystems
- 説明
- 提供されたキーでアクティベートされたシステムを一覧表示します。
- パラメーター
- string sessionKey
- string key
- 戻り値
- array:
- struct - system structure
- int
id
- システム ID - string
hostname
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時
4.16. listActivationKeys
- 名前
- listActivationKeys
- 説明
- ユーザーが認識可能なアクティベーションキーを一覧表示します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- 戻り値
- 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 - (パッケージで置換される予定)
- array
packages
- struct - package
- string
name
- packageName - string
arch
- archLabel - オプション
- boolean
universal_default
- boolean
disabled
4.17. listConfigChannels
- 名前
- listConfigChannels
- 説明
- アクティベーションキーに関連付けられている設定チャンネルを一覧表示します。
- パラメーター
- string sessionKey
- string key
- 戻り値
- 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
4.18. removeChildChannels
- 名前
- removeChildChannels
- 説明
- アクティベーションキーから子チャンネルを削除します。
- パラメーター
- string sessionKey
- string key
- array:
- string - childChannelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.19. removeConfigChannels
- 名前
- removeConfigChannels
- 説明
- 指定されたアクティベーションキーから設定チャンネルを削除します。
- パラメーター
- string sessionKey
- array:
- string - activationKey
- array:
- string - configChannelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.20. removeEntitlements
- 名前
- removeEntitlements
- 説明
- アクティベーションキーからエンタイトルメント (ラベルごと) を削除します。現行では、アドオンエンタイトルメントのみが許可されています。(provisioning_entitled、virtualization_host、virtualization_host_platform)
- パラメーター
- string sessionKey
- string key
- array string - entitlement label
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.21. removePackageNames
- 名前
- removePackageNames
- 説明
- アクティベーションキーからパッケージ名を削除します。廃止予定 - removePackages (string sessionKey、string key、array[packages]) に置換されます。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- string key
- array:
- string - packageName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.22. removePackages
- 名前
- removePackages
- 説明
- アクティベーションキーからパッケージ名を削除します。
- パラメーター
- string sessionKey
- string key
- array:
- struct - packages
- string
name
- パッケージ名 - string
arch
- Arch ラベル - オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.23. removeServerGroups
- 名前
- removeServerGroups
- 説明
- アクティベーションキーからサーバーグループを削除します。
- パラメーター
- string sessionKey
- string key
- array:
- int - serverGroupId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.24. setConfigChannels
- 名前
- setConfigChannels
- 説明
- 指定されたアクティベーションキー上の設定チャンネルの既存セットを置き換えます。チャンネルはアレイ内の順番で順位付けされます。
- パラメーター
- string sessionKey
- array:
- string - activationKey
- array:
- string - configChannelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
4.25. setDetails
- 名前
- setDetails
- 説明
- アクティベーションキーの詳細を更新します。
- パラメーター
- string sessionKey
- string key
- struct - activation key
- string
description
- オプション - string
base_channel_label
- オプション - 空ストリングまたは 'none' に設定されたベースチャンネルをデフォルトにします - int
usage_limit
- オプション - boolean
unlimited_usage_limit
- 無制限の使用に設定して usage_limit を上書きするには true に設定します。 - boolean
universal_default
- オプション - boolean
disabled
- オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第5章 api
概要
API についての情報を提供するメソッド
5.1. getApiCallList
- 名前
- getApiCallList
- 説明
- 名前空間ごとにグループ化された利用可能な api コールすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- struct - method_info
- string
name
- メソッド名 - string
parameters
- メソッドのパラメーター - string
exceptions
- メソッドの例外 - string
return
- メソッドの戻り値のタイプ
5.2. getApiNamespaceCallList
- 名前
- getApiNamespaceCallList
- 説明
- 指定された名前空間で利用可能な api コールすべてを一覧表示します。
- パラメーター
- string sessionKey
- string namespace
- 戻り値
- struct - method_info
- string
name
- メソッド名 - string
parameters
- メソッドのパラメーター - string
exceptions
- メソッドの例外 - string
return
- メソッドの戻り値のタイプ
5.3. getApiNamespaces
- 名前
- getApiNamespaces
- 説明
- 利用可能な API 名前空間を一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- struct - namespace
- string
namespace
- API 名前空間 - string
handler
- API ハンドラー
5.4. getVersion
- 名前
- getVersion
- 説明
- API のバージョンを返します。Spacewalk 0.4 (Satellite 5.3) 以降は、サーバーのバージョンとは関係ありません。
- パラメーター
- なし
- 戻り値
- string
5.5. systemVersion
- 名前
- systemVersion
- 説明
- サーバーのバージョンを返します。
- パラメーター
- なし
- 戻り値
- string
第6章 auth
概要
この名前空間は、システムの管理サーバーとの認識を行うメソッドを提供します。
6.1. login
- 名前
- login
- 説明
- ユーザー名とパスワードを使用したログインです。ほとんどの他の API メソッドで使用されるセッションキーが返されます。
- パラメーター
- string username
- string password
- 戻り値
- string sessionKey
6.2. login
- 名前
- login
- 説明
- ユーザー名とパスワードを使用したログインです。他のメソッドで使用されるセッションキーが返されます。
- パラメーター
- string username
- string password
- int duration - セッションの長さ。
- 戻り値
- string sessionKey
6.3. logout
- 名前
- logout
- 説明
- 指定されたセッションキーでユーザーをログアウトします。
- パラメーター
- string sessionKey
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第7章 channel
概要
ソフトウェアチャンネル一覧を取得するメソッドを提供します。
7.1. listAllChannels
- 名前
- listAllChannels
- 説明
- ユーザー組織に権利があるソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.2. listManageableChannels
- 名前
- listManageableChannels
- 説明
- ユーザーに管理権限があるソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.3. listMyChannels
- 名前
- listMyChannels
- 説明
- ユーザー組織に属するソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.4. listPopularChannels
- 名前
- listPopularChannels
- 説明
- 最も一般的なソフトウェアチャンネルを一覧表示します。人気の数で指定された数のシステムがサブスクライブしているチャンネルが返されます。
- パラメーター
- string sessionKey
- int popularityCount
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.5. listRedHatChannels
- 名前
- listRedHatChannels
- 説明
- ユーザー組織に権利がある Red Hat ソフトウェアチャンネルすべてを一覧表示します。廃止予定 - listVendorChannels(String sessionKey) に置換されます。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.6. listRetiredChannels
- 名前
- listRetiredChannels
- 説明
- リタイアしたソフトウェアチャンネルすべてを一覧表示します。これらのチャンネルはユーザーの組織に権利がありますが、有効期限が過ぎたためにサポート外となったものです。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.7. listSharedChannels
- 名前
- listSharedChannels
- 説明
- ユーザー組織で共有可能なソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
7.8. listSoftwareChannels
- 名前
- listSoftwareChannels
- 説明
- 認識可能なソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel
- string
label
- string
name
- string
parent_label
- string
end_of_life
- string
arch
7.9. listVendorChannels
- 名前
- listVendorChannels
- 説明
- ユーザー組織に権利があるベンダーソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel info
- int
id
- string
label
- string
name
- string
provider_name
- int
packages
- int
systems
- string
arch_name
第8章 channel.access
概要
チャンネルアクセスの制限を取得、変更するメソッドを提供します。
8.1. disableUserRestrictions
- 名前
- disableUserRestrictions
- 説明
- 指定されたチャンネルのユーザー制限を無効にします。これが無効になっていると、組織内の全ユーザーがそのチャンネルをサブスクライブすることができます。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
8.2. enableUserRestrictions
- 名前
- enableUserRestrictions
- 説明
- 指定されたチャンネルのユーザー制限を有効にします。これが有効になっていると、組織内の選択されたユーザーのみがそのチャンネルをサブスクライブすることができます。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
8.3. getOrgSharing
- 名前
- getOrgSharing
- 説明
- 組織に共有アクセス制御を付与します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- string - アクセスの値。'public'、'private'、または 'protected' のいずれか。
8.4. setOrgSharing
- 名前
- setOrgSharing
- 説明
- 組織に共有アクセス制御を設定します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string access - アクセス。'public'、'private'、または 'protected' のいずれか。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第9章 channel.org
概要
チャンネルにおける組織の信頼関係を取得、変更するメソッドを提供します。
9.1. disableAccess
- 名前
- disableAccess
- 説明
- 指定された組織でチャンネルへのアクセスを無効にします。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- int orgId - アクセスを削除される組織の ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
9.2. enableAccess
- 名前
- enableAccess
- 説明
- 指定された組織でチャンネルへのアクセスを有効にします。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- int orgId - アクセスを付与される組織の ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
9.3. list
- 名前
- list
- 説明
- 信頼できるチャンネルに関連付けられている全組織を一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- array:
- struct - org
- int
org_id
- string
org_name
- boolean
access_enabled
第10章 channel.software
概要
チャンネルの各側面にアクセス、修正するメソッドを提供します。
10.1. addPackages
- 名前
- addPackages
- 説明
- 指定されたチャンネルにパッケージリストを追加します。
- パラメーター
- string sessionKey
- string channelLabel - ターゲットチャンネル
- array:
- int - packageId - チャンネルに追加するパッケージの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.2. addRepoFilter
- 名前
- addRepoFilter
- 説明
- 特定のリポジトリー用にフィルターを追加します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- struct - filter_map
- string
filter
- フィルターをかける文字列 - string
flag
- include の場合は +、exclude の場合は -
- 戻り値
- int sort order for new filter
10.3. associateRepo
- 名前
- associateRepo
- 説明
- リポジトリーをチャンネルに関連付けます。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string repoLabel - リポジトリーラベル
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
10.4. availableEntitlements
- 名前
- availableEntitlements
- 説明
- 指定されたチャンネルで利用可能なサブスクリプション数を返します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- int 指定したチャンネルで利用可能なサブスクリプション数
10.5. clearRepoFilters
- 名前
- clearRepoFilters
- 説明
- リポジトリーのフィルターを削除します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.6. clone
- 名前
- clone
- 説明
- チャンネルをクローンします。arch_label を省略すると、元のチャンネルの arch ラベルが使用されます。parent_label が省略されると、クローンはベースチャンネルになります。
- パラメーター
- string sessionKey
- string original_label
- struct - channel details
- string
name
- string
label
- string
summary
- string
parent_label
- (オプション) - string
arch_label
- (オプション) - string
gpg_key_url
- (オプション)、gpg_url も使うことが可能 - string
gpg_key_id
- (オプション)、gpg_id も使うことが可能 - string
gpg_key_fp
- (オプション)、gpg_fingerprint も使うことが可能 - string
description
- (オプション) - string
checksum
- sha1 または sha256 のいずれか
- boolean original_state
- 戻り値
- int the cloned channel ID
10.7. create
- 名前
- create
- 説明
- ソフトウェアチャンネルを作成します。利用可能バージョン: 10.9 以降
- パラメーター
- string sessionKey
- string label - 新規チャンネルのラベル
- string name - 新規チャンネルの名前
- string summary - チャンネルの概要
- string archLabel - チャンネルが対応するアーキテクチャーのラベル。完全一覧は channel.software.listArches API を参照してください。
- string parentLabel - このチャンネルの親のラベル。親がない場合は、空の文字列
- string checksumType - このチャンネルの checksum タイプ。yum リポジトリーメタデータの生成に使用
- sha1 - クライアントとの最も幅広い互換性を提供します。
- sha256 - 高度なセキュリティーを提供しますが、Fedora 11 以降または Enterprise Linux 6 以降の新しいクライアントのみと互換性があります。
- struct - gpgKey
- string
url
- GPG キーの URL - string
id
- GPG キーの ID - string
fingerprint
- GPG キーのフィンガープリント
- 戻り値
- int - 作成が成功したら 1、それ以外は 0
10.8. create
- 名前
- create
- 説明
- ソフトウェアチャンネルを作成します。利用可能バージョン: 10.9 以降
- パラメーター
- string sessionKey
- string label - 新規チャンネルのラベル
- string name - 新規チャンネルの名前
- string summary - チャンネルの概要
- string archLabel - チャンネルが対応するアーキテクチャーのラベル。完全一覧は channel.software.listArches API を参照してください。
- string parentLabel - このチャンネルの親のラベル。親がない場合は、空の文字列
- string checksumType - このチャンネルの checksum タイプ。yum リポジトリーメタデータの生成に使用
- sha1 - クライアントとの最も幅広い互換性を提供します。
- sha256 - 高度なセキュリティーを提供しますが、Fedora 11 以降または Enterprise Linux 6 以降の新しいクライアントのみと互換性があります。
- 戻り値
- int - 作成が成功したら 1、それ以外は 0
10.9. create
- 名前
- create
- 説明
- ソフトウェアチャンネルを作成します。
- パラメーター
- string sessionKey
- string label - 新規チャンネルのラベル
- string name - 新規チャンネルの名前
- string summary - チャンネルの概要
- string archLabel - チャンネルが対応するアーキテクチャーのラベル。完全一覧は channel.software.listArches API を参照してください。
- string parentLabel - このチャンネルの親のラベル。親がない場合は、空の文字列
- 戻り値
- int - 作成が成功したら 1、それ以外は 0
10.10. createRepo
- 名前
- createRepo
- 説明
- リポジトリーを作成します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- string type - リポジトリータイプ (yum, uln...)
- string url - リポジトリーの url
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.11. createRepo
- 名前
- createRepo
- 説明
- リポジトリーを作成します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- string type - リポジトリータイプ (yum, uln...)
- string url - リポジトリーの url
- string sslCaCert - SSL CA 証明書の説明
- string sslCliCert - SSL Client 証明書の説明
- string sslCliKey - SSL Client 証明書の説明
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.12. delete
- 名前
- delete
- 説明
- カスタムソフトウェアチャンネルを削除します。
- パラメーター
- string sessionKey
- string channelLabel - 削除するチャンネル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.13. disassociateRepo
- 名前
- disassociateRepo
- 説明
- チャンネルからリポジトリーの関連を解除します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string repoLabel - リポジトリーラベル
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
10.14. getChannelLastBuildById
- 名前
- getChannelLastBuildById
- 説明
- 指定されたチャンネルの repomd.xml ファイルの最新のビルド日付をローカライズされた文字列で返します。
- パラメーター
- string sessionKey
- int id - 希望するチャンネルの ID
- 戻り値
- repomd.xml ファイルの最新のビルド日付をローカライズした文字列
10.15. getDetails
- 名前
- getDetails
- 説明
- 指定されたチャンネルの詳細をマップとして返します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
10.16. getDetails
- 名前
- getDetails
- 説明
- 指定されたチャンネルの詳細をマップとして返します。
- パラメーター
- string sessionKey
- int id - クエリするチャンネル
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
10.17. getRepoDetails
- 名前
- getRepoDetails
- 説明
- 指定されたリポジトリーの詳細を返します。
- パラメーター
- string sessionKey
- string repoLabel - クエリするリポジトリー
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.18. getRepoDetails
- 名前
- getRepoDetails
- 説明
- 指定されたリポジトリーの詳細を返します。
- パラメーター
- string sessionKey
- string repoLabel - クエリするリポジトリー
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.19. getRepoSyncCronExpression
- 名前
- getRepoSyncCronExpression
- 説明
- リポジトリー同期 cron 式を返します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- string quartz expression
10.20. isGloballySubscribable
- 名前
- isGloballySubscribable
- 説明
- 組織内のユーザーがチャンネルをサブスクライブできるかどうかを返します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- int - true なら 1、それ以外は 0
10.21. isUserManageable
- 名前
- isUserManageable
- 説明
- 特定のユーザーがチャンネルを管理できるかどうかを返します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string login - ターゲットユーザーのログイン
- 戻り値
- int - 管理可能なら 1、それ以外は 0
10.22. isUserSubscribable
- 名前
- isUserSubscribable
- 説明
- 特定のユーザーがチャンネルをサブスクライブできるかどうかを返します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string login - ターゲットユーザーのログイン
- 戻り値
- int - サブスクライブ可能なら 1、それ以外は 0
10.23. listAllPackages
- 名前
- listAllPackages
- 説明
- 指定された期間でパッケージバージョンに関係なく、チャンネル内の全パッケージを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- dateTime.iso8601 startDate
- dateTime.iso8601 endDate
- 戻り値
- 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
- (廃止予定)
10.24. listAllPackages
- 名前
- listAllPackages
- 説明
- バージョンに関係なく、指定した日付以降に変更されたチャンネル内の全パッケージを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- dateTime.iso8601 startDate
- 戻り値
- 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
- (廃止予定)
10.25. listAllPackages
- 名前
- listAllPackages
- 説明
- パッケージバージョンに関係なく、チャンネル内の全パッケージを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- 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
- (廃止予定)
10.26. listAllPackages
- 名前
- listAllPackages
- 説明
- 指定された期間でパッケージバージョンに関係なく、チャンネル内の全パッケージを一覧表示します。日付の例: '2008-08-20 08:00:00'廃止予定 - listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string startDate
- string endDate
- 戻り値
- 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
- (廃止予定)
10.27. listAllPackages
- 名前
- listAllPackages
- 説明
- バージョンに関係なく、指定した日付以降に変更されたチャンネル内の全パッケージを一覧表示します。日付の例: '2008-08-20 08:00:00'廃止予定 - listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string startDate
- 戻り値
- 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
- (廃止予定)
10.28. listAllPackagesByDate
- 名前
- listAllPackagesByDate
- 説明
- 指定された期間でパッケージバージョンに関係なく、チャンネル内の全パッケージを一覧表示します。日付の例: '2008-08-20 08:00:00'廃止予定 - listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string startDate
- string endDate
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- string
id
- string
arch_label
- string
last_modified
10.29. listAllPackagesByDate
- 名前
- listAllPackagesByDate
- 説明
- バージョンに関係なく、指定した日付以降に変更されたチャンネル内の全パッケージを一覧表示します。日付の例: '2008-08-20 08:00:00'廃止予定 - listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string startDate
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- string
id
- string
arch_label
- string
last_modified
10.30. listAllPackagesByDate
- 名前
- listAllPackagesByDate
- 説明
- パッケージバージョンに関係なく、チャンネル内の全パッケージを一覧表示します。廃止予定 - listAllPackages(string sessionKey, string channelLabel) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- string
id
- string
arch_label
- string
last_modified
10.31. listArches
- 名前
- listArches
- 説明
- 作成可能なソフトウェアチャンネルアーキテクチャーを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel arch
- string
name
- string
label
10.32. listChannelRepos
- 名前
- listChannelRepos
- 説明
- 指定されたチャンネルの関連リポジトリーを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- array:
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.33. listChildren
- 名前
- listChildren
- 説明
- チャンネルの子を一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
10.34. listErrata
- 名前
- listErrata
- 説明
- 指定された startDate 以降にチャンネルに適用可能なエラータを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- dateTime.iso8601 startDate
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
update_date
- エラータの更新日 - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前
10.35. listErrata
- 名前
- listErrata
- 説明
- startDate と endDate の間にチャンネルに適用可能なエラータを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- dateTime.iso8601 startDate
- dateTime.iso8601 endDate
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
update_date
- エラータの更新日 - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前
10.36. listErrata
- 名前
- listErrata
- 説明
- startDate と endDate の間にチャンネルに適用可能なエラータを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- dateTime.iso8601 startDate
- dateTime.iso8601 endDate
- boolean lastModified - select by last modified or not
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
update_date
- エラータの更新日 - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前
10.37. listErrata
- 名前
- listErrata
- 説明
- チャンネルに適用可能なエラータを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前 - string
advisory
- アドバイザリー名 (廃止予定) - string
issue_date
- 日付形式は YYYY-MM-DD HH24:MI:SS (廃止予定) - string
update_date
- 日付形式は YYYY-MM-DD HH24:MI:SS (廃止予定) - string
synopsis (廃止予定)
- string
last_modified_date
- 日付形式は YYYY-MM-DD HH24:MI:SS (廃止予定)
10.38. listErrata
- 名前
- listErrata
- 説明
- 指定された startDate 以降にチャンネルに適用可能なエラータを一覧表示します。廃止予定 - listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string startDate
- 戻り値
- array:
- struct - errata
- string
advisory
- アドバイザリー名 - string
issue_date
- 日付形式は YYYY-MM-DD HH24:MI:SS - string
update_date
- 日付形式は YYYY-MM-DD HH24:MI:SS - string
synopsis
- string
advisory_type
- string
last_modified_date
- 日付形式は YYYY-MM-DD HH24:MI:SS
10.39. listErrata
- 名前
- listErrata
- 説明
- startDate と endDate の間にチャンネルに適用可能なエラータを一覧表示します。廃止予定 - listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string startDate
- string endDate
- 戻り値
- array:
- struct - errata
- string
advisory
- アドバイザリー名 - string
issue_date
- 日付形式は YYYY-MM-DD HH24:MI:SS - string
update_date
- 日付形式は YYYY-MM-DD HH24:MI:SS - string
synopsis
- string
advisory_type
- string
last_modified_date
- 日付形式は YYYY-MM-DD HH24:MI:SS
10.40. listErrataByType
- 名前
- listErrataByType
- 説明
- チャンネルに適用可能な特定タイプのエラータを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- string advisoryType - アドバイザリーのタイプ ('Security Advisory'、'Product Enhancement Advisory'、'Bug Fix Advisory' のいずれか)
- 戻り値
- array:
- struct - errata
- string
advisory
- アドバイザリー名 - string
issue_date
- 日付形式は YYYY-MM-DD HH24:MI:SS - string
update_date
- 日付形式は YYYY-MM-DD HH24:MI:SS - string
synopsis
- string
advisory_type
- string
last_modified_date
- 日付形式は YYYY-MM-DD HH24:MI:SS
10.41. listErrataNeedingSync
- 名前
- listErrataNeedingSync
- 説明
- 新規チャンネルを satellite と同期すると、新たに同期されたチャンネルにあるパッケージで Red Hat Errata が更新されます。ただし、クローンされたエラータは自動的に更新されません。クローンされたエラータを含むチャンネルをクローンしていて、新規パッケージを含める必要がある場合でも、それらは含まれません。このメソッドは、syncErrata メソッドを実行した場合に更新されるエラータを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - 更新するチャンネル
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
update_date
- エラータの更新日 - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前
10.42. listLatestPackages
- 名前
- listLatestPackages
- 説明
- 指定されたチャンネルの最新バージョン (リリースおよびエポックを含む) のパッケージを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
10.43. listPackagesWithoutChannel
- 名前
- listPackagesWithoutChannel
- 説明
- チャンネルに関連づけられていないパッケージすべてを一覧表示します。通常はカスタムパッケージになります。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
- string
path
- パッケージが格納されているファイルシステムのパス - string
provider
- パッケージのプロバイダー。署名した gpg キーで判定。 - dateTime.iso8601
last_modified
10.44. listRepoFilters
- 名前
- listRepoFilters
- 説明
- リポジトリーのフィルターを一覧表示します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- 戻り値
- array:
- struct - filter
- int
sortOrder
- string
filter
- string
flag
10.45. listSubscribedSystems
- 名前
- listSubscribedSystems
- 説明
- 指定されたチャンネルラベルでサブスクライブしているシステム一覧を返します。
- パラメーター
- string sessionKey
- string channelLabel - クエリするチャンネル
- 戻り値
- array:
- struct - system
- int
id
- string
name
10.46. listSystemChannels
- 名前
- listSystemChannels
- 説明
- 特定のシステム ID でシステムがサブスクライブしているチャンネル一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - channel
- string
id
- string
label
- string
name
10.47. listUserRepos
- 名前
- listUserRepos
- 説明
- ユーザーから見ることができる ContentSource (repos) の一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - map
- long "id" - リポジトリーの ID
- string
label
- リポジトリーのラベル - string
sourceUrl
- リポジトリーの URL
10.48. mergeErrata
- 名前
- mergeErrata
- 説明
- あるチャンネルからのエラータすべてを別のチャンネルにマージします。
- パラメーター
- string sessionKey
- string mergeFromLabel - エラータをプルするチャンネルのラベル
- string mergeToLabel - エラータのプッシュ先となるラベル
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
10.49. mergeErrata
- 名前
- mergeErrata
- 説明
- 特定の開始/終了日に基づいて、あるチャンネルからのエラータすべてを別のチャンネルにマージします。
- パラメーター
- string sessionKey
- string mergeFromLabel - エラータをプルするチャンネルのラベル
- string mergeToLabel - エラータのプッシュ先となるラベル
- string startDate
- string endDate
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
10.50. mergeErrata
- 名前
- mergeErrata
- 説明
- あるチャンネルからのエラータ一覧を別のチャンネルにマージします。
- パラメーター
- string sessionKey
- string mergeFromLabel - エラータをプルするチャンネルのラベル
- string mergeToLabel - エラータのプッシュ先となるラベル
- array:
- string - advisory - マージするエラータのアドバイザリー名
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
10.51. mergePackages
- 名前
- mergePackages
- 説明
- あるチャンネルからのパッケージすべてを別のチャンネルにマージします。
- パラメーター
- string sessionKey
- string mergeFromLabel - パッケージをプルするチャンネルのラベル
- string mergeToLabel - パッケージのプッシュ先となるラベル
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
- string
path
- パッケージが格納されているファイルシステムのパス - string
provider
- パッケージのプロバイダー。署名した gpg キーで判定。 - dateTime.iso8601
last_modified
10.52. regenerateNeededCache
- 名前
- regenerateNeededCache
- 説明
- 特定のチャンネルにサブスクライブしている全システムの必要なエラータとパッケージキャッシュを完全にクリアして、再生成します。特定のチャンネルで全システムについてキャッシュが正しくないと思われる場合にのみ、これを使用してください。実際に処理を行う非同期アクションがスケジュールされます。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.53. regenerateNeededCache
- 名前
- regenerateNeededCache
- 説明
- サブスクライブしている全システムの必要なエラータとパッケージキャッシュを完全にクリアして、再生成します。Satellite 管理者のみがこのアクションを実行できます。実際に処理を行う非同期アクションがスケジュールされます。
- パラメーター
- string sessionKey
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.54. regenerateYumCache
- 名前
- regenerateYumCache
- 説明
- 指定されたチャンネルの yum キャッシュを再生成します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.55. removeErrata
- 名前
- removeErrata
- 説明
- 特定のエラータリストを特定のチャンネルから削除します。
- パラメーター
- string sessionKey
- string channelLabel - ターゲットチャンネル
- array:
- string - advisoryName - 削除するエラータ名
- boolean removePackages - チャンネルからパッケージを削除するには、True にします。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.56. removePackages
- 名前
- removePackages
- 説明
- 特定のパッケージリストを特定のチャンネルから削除します。
- パラメーター
- string sessionKey
- string channelLabel - ターゲットチャンネル
- array:
- int - packageId - チャンネルから削除するパッケージの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.57. removeRepo
- 名前
- removeRepo
- 説明
- リポジトリーを削除します。
- パラメーター
- string sessionKey
- long id - 削除するリポジトリーの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.58. removeRepo
- 名前
- removeRepo
- 説明
- リポジトリーを削除します。
- パラメーター
- string sessionKey
- string label - 削除するリポジトリーのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.59. removeRepoFilter
- 名前
- removeRepoFilter
- 説明
- 特定のリポジトリー用のフィルターを削除します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- struct - filter_map
- string
filter
- フィルターをかける文字列 - string
flag
- include の場合は +、exclude の場合は -
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.60. setContactDetails
- 名前
- setContactDetails
- 説明
- 特定チャンネルの連絡先、サポート情報を設定します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string maintainerName - チャンネルメンテナーの名前
- string maintainerEmail - チャンネルメンテナーの email
- string maintainerPhone - チャンネルメンテナーの電話番号
- string supportPolicy - チャンネルのサポートポリシー
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.61. setDetails
- 名前
- setDetails
- 説明
- チャンネル属性の変更を可能にします。
- パラメーター
- string sessionKey
- int channelId - チャンネル ID
- struct - channel_map
- string
checksum_label
- 新規チャンネルリポジトリーのチェックサムラベル (オプション) - string
name
- 新規チャンネル名 (オプション) - string
summary
- 新規チャンネルの概要 (オプション) - string
description
- 新規チャンネルの説明 (オプション) - string
maintainer_name
- 新規チャンネルのメンテナーの名前 (オプション) - string
maintainer_email
- 新規チャンネルメンテナーの email アドレス (オプション) - string
maintainer_phone
- 新規チャンネルメンテナーの電話番号 (オプション) - string
gpg_key_url
- 新規チャンネルの gpg キー url (オプション) - string
gpg_key_id
- 新規チャンネルの gpg キー ID (オプション) - string
gpg_key_fp
- 新規チャンネルの gpg キーフィンガープリント (オプション)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.62. setGloballySubscribable
- 名前
- setGloballySubscribable
- 説明
- 特定チャンネルでグローバルにサブスクライブ可能な属性を設定します。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- boolean subscribable - チャンネルがグローバルでサブスクライブ可能な場合は true、それ以外は False。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.63. setRepoFilters
- 名前
- setRepoFilters
- 説明
- 特定リポジトリーの既存のフィルターセットを置換します。フィルターはアレイ内の順番で順位付けされます。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- array:
- struct - filter_map
- string
filter
- フィルターをかける文字列 - string
flag
- include の場合は +、exclude の場合は -
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.64. setSystemChannels
- 名前
- setSystemChannels
- 説明
- システムがサブスクライブしているチャンネルを渡されたチャンネル一覧に変更します。廃止予定 - system.setBaseChannel(string sessionKey, int serverId, string channelLabel) および system.setChildChannels(string sessionKey, int serverId, array[string channelLabel]) に置換されます。
- パラメーター
- string sessionKey
- int serverId
- array:
- string - channelLabel - システムがサブスクライブするチャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.65. setUserManageable
- 名前
- setUserManageable
- 説明
- 特定チャンネルおよびユーザー用の管理可能なフラグを設定します。値を 'true' に設定すると、このメソッドはユーザーにチャンネルへの管理パーミッションを付与します。それ以外の場合は、その権限が取り消されます。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string login - ターゲットユーザーのログイン
- boolean value - 設定するフラグの値
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.66. setUserSubscribable
- 名前
- setUserSubscribable
- 説明
- 特定チャンネルおよびユーザー用のサブスクライブ可能なフラグを設定します。値を 'true' に設定すると、このメソッドはユーザーにチャンネルへのサブスクライブパーミッションを付与します。それ以外の場合は、その権限が取り消されます。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string login - ターゲットユーザーのログイン
- boolean value - 設定するフラグの値
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.67. subscribeSystem
- 名前
- subscribeSystem
- 説明
- システムがチャンネル一覧をサブスクライブするようにします。ベースチャンネルを含める場合は、子チャンネルの設定前にそれが設定されます。子チャンネルの設定時には、現行の子チャンネルサブスクリプションがクリアされます。システムが全チャンネルからサブスクライブ解除するには、空のチャンネルラベルの一覧を提供します。廃止予定 - system.setBaseChannel(string sessionKey, int serverId, string channelLabel) および system.setChildChannels(string sessionKey, int serverId, array[string channelLabel]) に置換されます。
- パラメーター
- string sessionKey
- int serverId
- array:
- string - label - システムがサブスクライブするチャンネルラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.68. syncErrata
- 名前
- syncErrata
- 説明
- 新規チャンネルを satellite と同期すると、新たに同期されたチャンネルにあるパッケージで Red Hat Errata が更新されます。ただし、クローンされたエラータは自動的に更新されません。クローンされたエラータを含むチャンネルをクローンしていて、新規パッケージを含める必要がある場合でも、それらは含まれません。このメソッドは、指定されたクローンチャンネル内の全エラータを最近追加されたパッケージで更新し、予想するすべてのパッケージがチャンネル内に存在するようにします。
- パラメーター
- string sessionKey
- string channelLabel - 更新するチャンネル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.69. syncRepo
- 名前
- syncRepo
- 説明
- リポジトリー同期を即座にトリガーします。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.70. syncRepo
- 名前
- syncRepo
- 説明
- リポジトリー同期を即座にトリガーします。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- struct - params_map
- Boolean
sync-kickstart
- キックスタート可能なツリーを作成します - オプション - Boolean
no-errata
- エラータを同期しません - オプション - Boolean
fail
- エラー発生時に終了します - オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.71. syncRepo
- 名前
- syncRepo
- 説明
- 定期的なリポジトリー同期をスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string cron expression - 空の場合は、すべての定期スケジュールが無効になります。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.72. syncRepo
- 名前
- syncRepo
- 説明
- 定期的なリポジトリー同期をスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - チャンネルのラベル
- string cron expression - 空の場合は、すべての定期スケジュールが無効になります。
- struct - params_map
- Boolean
sync-kickstart
- キックスタート可能なツリーを作成します - オプション - Boolean
no-errata
- エラータを同期しません - オプション - Boolean
fail
- エラー発生時に終了します - オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
10.73. updateRepo
- 名前
- updateRepo
- 説明
- ContentSource リポジトリーを更新します。
- パラメーター
- string sessionKey
- int id - リポジトリー ID
- string label - 新規リポジトリーラベル
- string url - 新規リポジトリーの url
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.74. updateRepoLabel
- 名前
- updateRepoLabel
- 説明
- リポジトリーラベルを更新します。
- パラメーター
- string sessionKey
- int id - リポジトリー ID
- string label - 新規リポジトリーラベル
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.75. updateRepoLabel
- 名前
- updateRepoLabel
- 説明
- リポジトリーラベルを更新します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- string newLabel - 新規リポジトリーラベル
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.76. updateRepoSsl
- 名前
- updateRepoSsl
- 説明
- リポジトリーの SSL 証明書を更新します。
- パラメーター
- string sessionKey
- int id - リポジトリー ID
- string sslCaCert - SSL CA 証明書の説明
- string sslCliCert - SSL Client 証明書の説明
- string sslCliKey - SSL Client 証明書の説明
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.77. updateRepoSsl
- 名前
- updateRepoSsl
- 説明
- リポジトリーの SSL 証明書を更新します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- string sslCaCert - SSL CA 証明書の説明
- string sslCliCert - SSL Client 証明書の説明
- string sslCliKey - SSL Client 証明書の説明
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.78. updateRepoUrl
- 名前
- updateRepoUrl
- 説明
- リポジトリーソース URL を更新します。
- パラメーター
- string sessionKey
- int id - リポジトリー ID
- string url - 新規リポジトリーの url
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
10.79. updateRepoUrl
- 名前
- updateRepoUrl
- 説明
- リポジトリーソース URL を更新します。
- パラメーター
- string sessionKey
- string label - リポジトリーラベル
- string url - 新規リポジトリーの url
- 戻り値
- struct - channel
- int
id
- string
label
- string
sourceUrl
- string
type
- string
sslCaDesc
- string
sslCertDesc
- string
sslKeyDesc
第11章 configchannel
概要
設定チャンネルの各側面にアクセス、修正するメソッドを提供します。
11.1. channelExists
- 名前
- channelExists
- 説明
- 提供された設定チャンネルが存在するかどうかを確認します。
- パラメーター
- string sessionKey
- string channelLabel - 確認するチャンネル
- 戻り値
- 存在する場合は 1、それ以外は 0
11.2. create
- 名前
- create
- 説明
- 新規のグローバル設定チャンネルを作成します。発信者は設定管理者か組織管理者である必要があります。
- パラメーター
- string sessionKey
- string channelLabel
- string channelName
- string channelDescription
- 戻り値
- 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
11.3. createOrUpdatePath
- 名前
- createOrUpdatePath
- 説明
- 指定されたパスで新規ファイルまたはディレクトリーを作成するか、既存のパスを更新します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- string configChannelLabel
- string path
- boolean isDir - パスがディレクトリーの場合は True、ファイルの場合は False
- struct - path info
- string
contents
- ファイルのコンテンツ (テキストまたはバイナリの場合は base64 によるエンコード)。(ディレクトリー以外の場合のみ) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 (デフォルト: disabled、ディレクトリー以外の場合のみ) - string
owner
- ファイル/ディレクトリーの所有者 - string
group
- ファイル/ディレクトリーのグループ名 - string
permissions
- 8 進数によるファイル/ディレクトリーのパーミッション (例: 644) - string
selinux_ctx
- SELinux Security コンテキスト (オプション) - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。デフォルト値を受け付けるには、null または空の文字列を使用します。(ディレクトリー以外の場合のみ) - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。デフォルト値を受け付けるには、null または空の文字列を使用します。(ディレクトリー以外の場合のみ) - int
revision
- 次の改訂番号、null の場合は自動増加 - boolean
binary
- バイナリコンテンツをマーク。True の場合は、base64 エンコード化されたコンテンツが予想されます (ディレクトリー以外の場合のみ)
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.4. createOrUpdateSymlink
- 名前
- createOrUpdateSymlink
- 説明
- 指定されたパスで新規のシンボリックリンクを作成するか、既存のパスを更新します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- string configChannelLabel
- string path
- struct - path info
- string
target_path
- シンボリックリンクのターゲットパス。 - string
selinux_ctx
- SELinux Security コンテキスト (オプション) - int
revision
- 次の改訂番号、改訂番号の自動割り当ての場合はこのフィールドをスキップします。
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.5. deleteChannels
- 名前
- deleteChannels
- 説明
- グローバル設定チャンネルの一覧を削除します。発信者は設定管理者である必要があります。
- パラメーター
- string sessionKey
- array:
- string - 削除する設定チャンネルラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.6. deleteFileRevisions
- 名前
- deleteFileRevisions
- 説明
- 指定された設定ファイルの特定の版を削除します。
- パラメーター
- string sessionKey
- string channelLabel - ルックアップする設定チャンネルのラベル
- string filePath - 設定ファイルのパス
- array:
- int - 削除する版の一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.7. deleteFiles
- 名前
- deleteFiles
- 説明
- グローバルチャンネルからファイルパスを削除します。
- パラメーター
- string sessionKey
- string channelLabel - 削除するファイルがあるチャンネル
- array:
- string - 削除するファイルのパス
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.8. deployAllSystems
- 名前
- deployAllSystems
- 説明
- 特定の設定チャンネルをサブスクライブしている全システムで設定の即時デプロイをスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - 設定チャンネルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.9. deployAllSystems
- 名前
- deployAllSystems
- 説明
- 特定の設定チャンネルをサブスクライブしている全システムで設定のデプロイをスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - 設定チャンネルのラベル
- dateTime.iso8601 date - アクションをスケジュールする日付
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.10. deployAllSystems
- 名前
- deployAllSystems
- 説明
- 特定の設定チャンネルをサブスクライブしている全システムで特定ファイルの設定デプロイをスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - 設定チャンネルのラベル
- string filePath - 設定ファイルのパス
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.11. deployAllSystems
- 名前
- deployAllSystems
- 説明
- 特定の設定チャンネルをサブスクライブしている全システムで特定ファイルの設定デプロイをスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - 設定チャンネルのラベル
- string filePath - 設定ファイルのパス
- dateTime.iso8601 date - アクションをスケジュールする日付
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
11.12. getDetails
- 名前
- getDetails
- 説明
- 設定チャンネルの詳細をルックアップします。
- パラメーター
- string sessionKey
- string channelLabel
- 戻り値
- 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
11.13. getDetails
- 名前
- getDetails
- 説明
- 設定チャンネルの詳細をルックアップします。
- パラメーター
- string sessionKey
- int channelId
- 戻り値
- 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
11.14. getEncodedFileRevision
- 名前
- getEncodedFileRevision
- 説明
- 指定された設定ファイルのバージョンを取得し、base64 エンコード化したコンテンツを送信します。
- パラメーター
- string sessionKey
- string configChannelLabel - ルックアップする設定チャンネルのラベル
- string filePath - 調べる設定ファイルのパス
- int revision - 調べる設定ファイルのバージョン
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.15. getFileRevision
- 名前
- getFileRevision
- 説明
- 指定された設定ファイルのバージョンを取得します。
- パラメーター
- string sessionKey
- string configChannelLabel - ルックアップする設定チャンネルのラベル
- string filePath - 調べる設定ファイルのパス
- int revision - 調べる設定ファイルのバージョン
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.16. getFileRevisions
- 名前
- getFileRevisions
- 説明
- 指定された設定ファイルのバージョン一覧を取得します。
- パラメーター
- string sessionKey
- string channelLabel - ルックアップする設定チャンネルのラベル
- string filePath - 調べる設定ファイルのパス
- 戻り値
- array:
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.17. listFiles
- 名前
- listFiles
- 説明
- チャンネル内のファイル一覧が返されます。
- パラメーター
- string sessionKey
- string channelLabel - ファイルを一覧表示する設定ファイルのラベル
- 戻り値
- array:
- struct - Configuration File information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - dateTime.iso8601
last_modified
- 最終修正日
11.18. listGlobals
- 名前
- listGlobals
- 説明
- ログインユーザーがアクション可能なグローバル設定チャンネルをすべて一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- 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
11.19. listSubscribedSystems
- 名前
- listSubscribedSystems
- 説明
- 設定チャンネルをサブスクライブしているシステム一覧を返します。
- パラメーター
- string sessionKey
- string channelLabel - サブスクライブしているシステムを一覧表示する設定ファイルのラベル
- 戻り値
- array:
- struct - system
- int
id
- string
name
11.20. lookupChannelInfo
- 名前
- lookupChannelInfo
- 説明
- チャンネルラベルを提供しているチャンネル一覧についての詳細を一覧表示します。
- パラメーター
- string sessionKey
- array:
- string - 設定チャンネルラベル
- 戻り値
- 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
11.21. lookupFileInfo
- 名前
- lookupFileInfo
- 説明
- パスとチャンネルのリストを指定すると、最新バージョンのパスの詳細を返します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- string channelLabel - ルックアップする設定チャンネルのラベル
- array:
- string - 調べるパスの一覧
- 戻り値
- array:
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.22. lookupFileInfo
- 名前
- lookupFileInfo
- 説明
- パスと改訂番号、チャンネルを指定すると、最新バージョンのパスの詳細を返します。利用可能バージョン: 10.12 以降
- パラメーター
- string sessionKey
- string channelLabel - ルックアップする設定チャンネルのラベル
- string path - ファイル/ディレクトリーのパス
- int revsion - 改訂番号
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
11.23. scheduleFileComparisons
- 名前
- scheduleFileComparisons
- 説明
- 最新バージョンのファイルとシステム一覧上にデプロイされているバージョンの比較をスケジュールします。
- パラメーター
- string sessionKey
- string channelLabel - 設定チャンネルのラベル
- string path - ファイルのパス
- array:
- long - 比較が実行されるサーバー ID の一覧
- 戻り値
- int actionId - 予定されるアクションのアクション ID
11.24. update
- 名前
- update
- 説明
- グローバル設定チャンネルを更新します。発信者は設定管理者か組織管理者であるか、この設定チャンネルがあるシステムにアクセスできる必要があります。
- パラメーター
- string sessionKey
- string channelLabel
- string channelName
- string description
- 戻り値
- 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
第12章 distchannel
概要
配信チャンネル情報にアクセス、修正するメソッドを提供します。
12.1. listDefaultMaps
- 名前
- listDefaultMaps
- 説明
- デフォルトの配信チャンネルマップを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - distChannelMap
- string
os
- オペレーティングシステム - string
release
- OS リリース - string
arch_name
- チャンネルアーカイブ - string
channel_label
- チャンネルのラベル - string
org_specific
- 'Y' 組織固有、'N' デフォルト
12.2. listMapsForOrg
- 名前
- listMapsForOrg
- 説明
- ユーザーの組織で有効な配信チャンネルマップを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - distChannelMap
- string
os
- オペレーティングシステム - string
release
- OS リリース - string
arch_name
- チャンネルアーカイブ - string
channel_label
- チャンネルのラベル - string
org_specific
- 'Y' 組織固有、'N' デフォルト
12.3. listMapsForOrg
- 名前
- listMapsForOrg
- 説明
- 組織で有効な配信チャンネルマップを一覧表示します。satellite の管理者権限が必要です。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- array:
- struct - distChannelMap
- string
os
- オペレーティングシステム - string
release
- OS リリース - string
arch_name
- チャンネルアーカイブ - string
channel_label
- チャンネルのラベル - string
org_specific
- 'Y' 組織固有、'N' デフォルト
12.4. setMapForOrg
- 名前
- setMapForOrg
- 説明
- 組織内の配信チャンネルマップを設定、上書き (channelLabel が空の場合は削除) します。
- パラメーター
- string sessionKey
- string os
- string release
- string archName
- string channelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第13章 errata
概要
エラータにアクセス、修正するメソッドを提供します。
13.1. addPackages
- 名前
- addPackages
- 説明
- 指定されたアドバイザリー名のエラータにパッケージセットを追加します。このメソッドでは、UI または API で作成されたカスタムエラータの修正のみが可能です。
- パラメーター
- string sessionKey
- string advisoryName
- array:
- int - packageId
- 戻り値
- int - 追加されたパッケージ数を表します、それ以外は exception
13.2. applicableToChannels
- 名前
- applicableToChannels
- 説明
- 指定されたアドバイザリー名のエラータに適用可能なチャンネル一覧を返します。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- array:
- struct - channel
- int
channel_id
- string
label
- string
name
- string
parent_channel_label
13.3. bugzillaFixes
- 名前
- bugzillaFixes
- 説明
- 指定された advisoryName に一致するエラータの Bugzilla 修正を取得します。バグは struct で返され、バグ ID が以下のようにキーになります。例: 208144="errata.bugzillaFixes Method Returns different results than docs say"
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- struct - Bugzilla info
- string
bugzilla_id
- 実際のバグ番号が struct のキーになります。 - string
bug_summary
- キーがバグ ID となる概要
13.4. clone
- 名前
- clone
- 説明
- 指定されたチャンネルにエラータ一覧をクローンします。
- パラメーター
- string sessionKey
- string channel_label
- array:
- string - advisory - クローンするエラータのアドバイザリー名
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.5. cloneAsOriginal
- 名前
- cloneAsOriginal
- 説明
- 元のエラータに従って指定されたクローンチャンネルにエラータ一覧をクローンします。
- パラメーター
- string sessionKey
- string channel_label
- array:
- string - advisory - クローンするエラータのアドバイザリー名
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.6. cloneAsOriginalAsync
- 名前
- cloneAsOriginalAsync
- 説明
- 元のエラータに従って指定されたクローンチャンネルにエラータ一覧を非同期的にクローンします。
- パラメーター
- string sessionKey
- string channel_label
- array:
- string - advisory - クローンするエラータのアドバイザリー名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
13.7. cloneAsync
- 名前
- cloneAsync
- 説明
- 指定されたチャンネルにエラータ一覧を非同期型にクローンします。
- パラメーター
- string sessionKey
- string channel_label
- array:
- string - advisory - クローンするエラータのアドバイザリー名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
13.8. create
- 名前
- create
- 説明
- カスタムエラータを作成します。"publish" を true に設定すると、エラータは公開もされます。
- パラメーター
- string sessionKey
- struct - errata info
- string
synopsis
- string
advisory_name
- int
advisory_release
- string
advisory_type
- アドバイザリーのタイプ ('Security Advisory'、'Product Enhancement Advisory'、'Bug Fix Advisory' のいずれか) - string
product
- string
errataFrom
- string
topic
- string
description
- string
references
- string
notes
- string
solution
- array:
- struct - bug
- int
id
- Bug Id - string
summary
- string
url
- array:
- string - keyword - エラータに関連付けるキーワード一覧
- array:
- int - packageId
- boolean publish - エラータが公開される場合。
- array:
- string - channelLabel - エラータが公開される場合のチャンネル一覧。publish が false に設定されていると無視されます。
- 戻り値
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.9. delete
- 名前
- delete
- 説明
- エラータを削除します。このメソッドでは、UI または API で作成されたカスタムエラータの削除のみが可能です。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
13.10. findByCve
- 名前
- findByCve
- 説明
- 指定された CVE (例: CVE-2008-3270) に関連付けられているエラータの詳細をルックアップします。
- パラメーター
- string sessionKey
- string cveName
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.11. getDetails
- 名前
- getDetails
- 説明
- 指定されたアドバイザリー名に一致するエラータの詳細を取得します。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- struct - erratum
- int
id
- string
issue_date
- string
update_date
- string
last_modified_date
- この日付は公開されているエラータの場合にのみ含まれ、エラータの最終更新日を表します。 - string
synopsis
- int
release
- string
type
- string
product
- string
errataFrom
- string
topic
- string
description
- string
references
- string
notes
- string
solution
13.12. listAffectedSystems
- 名前
- listAffectedSystems
- 説明
- アドバイザリー名のエラータに影響を受けるシステム一覧を返します。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
13.13. listByDate
- 名前
- listByDate
- 説明
- 特定のチャンネルに日付別に適用されたエラータを一覧表示します。廃止予定 - channel.software.listErrata(User LoggedInUser, string channelLabel) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.14. listCves
- 名前
- listCves
- 説明
- 指定されたアドバイザリー名のエラータに適用可能な CVE 一覧を返します。CVE は、公開されているエラータにのみ関連付けることができます。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- array:
- string - cveName
13.15. listKeywords
- 名前
- listKeywords
- 説明
- 指定されたアドバイザリーに一致するエラータに関連付けられているキーワードを取得します。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- array:
- string - エラータに関連付けられているキーワード
13.16. listPackages
- 名前
- listPackages
- 説明
- 指定されたアドバイザリー名のエラータに影響を受けるパッケージ一覧を返します。
- パラメーター
- string sessionKey
- string advisoryName
- 戻り値
- 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
13.17. listUnpublishedErrata
- 名前
- listUnpublishedErrata
- 説明
- 未公開のエラータ一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - erratum
- int
id
- int
published
- string
advisory
- string
advisory_name
- string
advisory_type
- string
synopsis
- dateTime.iso8601
created
- dateTime.iso8601
update_date
13.18. publish
- 名前
- publish
- 説明
- 既存の (未公開) エラータをチャンネルセットに公開します。
- パラメーター
- string sessionKey
- string advisoryName
- array:
- string - channelLabel - 公開先となるチャンネルラベル一覧
- 戻り値
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.19. publishAsOriginal
- 名前
- publishAsOriginal
- 説明
- 元のエラータに従ってクローンチャンネルセットに既存の (未公開) クローンエラータを公開します。
- パラメーター
- string sessionKey
- string advisoryName
- array:
- string - channelLabel - 公開先となるチャンネルラベル一覧
- 戻り値
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
13.20. removePackages
- 名前
- removePackages
- 説明
- 指定されたアドバイザリー名のエラータからパッケージセットを削除します。このメソッドでは、UI または API で作成されたカスタムエラータの修正のみが可能です。
- パラメーター
- string sessionKey
- string advisoryName
- array:
- int - packageId
- 戻り値
- int - 削除されるパッケージ数を表します、それ以外は exception
13.21. setDetails
- 名前
- setDetails
- 説明
- エラータの詳細を設定します。引数はすべてオプションで、struct に含まれている場合にのみ、修正されます。このメソッドでは、UI または API で作成されたカスタムエラータの修正のみが可能です。
- パラメーター
- string sessionKey
- string advisoryName
- struct - errata details
- string
synopsis
- string
advisory_name
- int
advisory_release
- string
advisory_type
- アドバイザリーのタイプ ('Security Advisory'、'Product Enhancement Advisory'、'Bug Fix Advisory' のいずれか) - string
product
- dateTime.iso8601
issue_date
- dateTime.iso8601
update_date
- string
errataFrom
- string
topic
- string
description
- string
references
- string
notes
- string
solution
- array
bugs
- 'bugs' は struct へのキー - array:
- struct - bug
- int
id
- Bug Id - string
summary
- string
url
- array
keywords
- 'keywords' は struct へのキー - array:
- string - keyword - エラータに関連付けるキーワード一覧
- array
CVEs
- 'cves' は struct へのキー - array:
- string - cves - エラータに関連付ける CVE 一覧 (公開済みエラータのみ有効)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第14章 kickstart
概要
キックスタートファイルを作成するメソッドを提供します。
14.1. cloneProfile
- 名前
- cloneProfile
- 説明
- キックスタートプロファイルをクローンします。
- パラメーター
- string sessionKey
- string ksLabelToClone - クローンするキックスタートプロファイルのラベル
- string newKsLabel - クローンされたプロファイルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.2. createProfile
- 名前
- createProfile
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartHost - 新規キックスタートプロファイルのデフォルトダウンロード URL の構築に使用するキックスタートホスト名 (satellite またはプロキシ)
- string rootPassword - Root パスワード
- string updateType - プロファイル更新自体が利用可能な最終ツリーを使用するかどうか。可能な値は: none (デフォルト)、red_hat (Red Hat と同期されたキックスタートツリーのみを使用)、all (カスタムキックスタートツリーを含む)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.3. createProfile
- 名前
- createProfile
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartHost - 新規キックスタートプロファイルのデフォルトダウンロード URL の構築に使用するキックスタートホスト名 (satellite またはプロキシ)
- string rootPassword - Root パスワード
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.4. createProfileWithCustomUrl
- 名前
- createProfileWithCustomUrl
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- boolean downloadUrl - ダウンロードの URL。キックスタートツリーのデフォルト URL を使用する場合は 'default'
- string rootPassword - Root パスワード
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.5. createProfileWithCustomUrl
- 名前
- createProfileWithCustomUrl
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- boolean downloadUrl - ダウンロードの URL。キックスタートツリーのデフォルト URL を使用する場合は 'default'
- string rootPassword - Root パスワード
- string updateType - プロファイル更新自体が利用可能な最終ツリーを使用するかどうか。可能な値は: none (デフォルト)、red_hat (Red Hat と同期されたキックスタートツリーのみを使用)、all (カスタムキックスタートツリーを含む)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.6. deleteProfile
- 名前
- deleteProfile
- 説明
- キックスタートプロファイルを削除します。
- パラメーター
- string sessionKey
- string ksLabel - 削除するキックスタートプロファイルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.7. disableProfile
- 名前
- disableProfile
- 説明
- キックスタートプロファイルを有効/無効にします。
- パラメーター
- string sessionKey
- string profileLabel - 有効/無効にするキックスタートツリーのラベル
- string disabled - プロファイルを無効にする場合は true
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.8. findKickstartForIp
- 名前
- findKickstartForIp
- 説明
- 特定の IP アドレスに関連するキックスタートを見つけます。
- パラメーター
- string sessionKey
- string ipAddress - 検索する IP アドレス (例: 192.168.0.1)
- 戻り値
- string - キックスタートのラベル。見つからない場合は空の文字列 ("")
14.9. importFile
- 名前
- importFile
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartFileContents - インポートするキックスタートファイルのコンテンツ
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.10. importFile
- 名前
- importFile
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartHost - 新規キックスタートプロファイルのデフォルトダウンロード URL の構築に使用するキックスタートホスト名 (satellite またはプロキシ)。このオプションを使用すると、キックスタートファイル自体にある url/nfs/cdrom/harddrive コマンドではなく、このデフォルトの URL が使用されます。
- string kickstartFileContents - インポートするキックスタートファイルのコンテンツ
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.11. importFile
- 名前
- importFile
- 説明
- キックスタートプロファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartHost - 新規キックスタートプロファイルのデフォルトダウンロード URL の構築に使用するキックスタートホスト名 (satellite またはプロキシ)。このオプションを使用すると、キックスタートファイル自体にある url/nfs/cdrom/harddrive コマンドではなく、このデフォルトの URL が使用されます。
- string kickstartFileContents - インポートするキックスタートファイルのコンテンツ
- string updateType - プロファイル更新自体が利用可能な最終ツリーを使用するかどうか。可能な値は: none (デフォルト)、red_hat (Red Hat と同期されたキックスタートツリーのみを使用)、all (カスタムキックスタートツリーを含む)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.12. importRawFile
- 名前
- importRawFile
- 説明
- satellite に raw のキックスタートファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartFileContents - インポートするキックスタートファイルのコンテンツ
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.13. importRawFile
- 名前
- importRawFile
- 説明
- satellite に raw のキックスタートファイルをインポートします。
- パラメーター
- string sessionKey
- string profileLabel - 新規キックスタートプロファイルのラベル
- string virtualizationType - none、para_host、qemu、xenfv、xenpv のいずれか。
- string kickstartableTreeLabel - 新規プロファイルに関連付けるキックスタートが可能なツリーのラベル
- string kickstartFileContents - インポートするキックスタートファイルのコンテンツ
- string updateType - プロファイル更新自体が利用可能な最終ツリーを使用するかどうか。可能な値は: none (デフォルト)、red_hat (Red Hat と同期されたキックスタートツリーのみを使用)、all (カスタムキックスタートツリーを含む)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
14.14. isProfileDisabled
- 名前
- isProfileDisabled
- 説明
- キックスタートプロファイルが無効かどうかを返します。
- パラメーター
- string sessionKey
- string profileLabel - キックスタートプロファイルのラベル
- 戻り値
- プロファイルを無効にする場合は true
14.15. listAllIpRanges
- 名前
- listAllIpRanges
- 説明
- すべての IP 範囲とユーザーの組織内で利用可能な関連するキックスタートを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - Kickstart Ip Range
- string
ksLabel
- IP 範囲に関連付けられているキックスタートのラベル - string
max
- IP 範囲の最大値 - string
min
- IP 範囲の最小値
14.16. listKickstartableChannels
- 名前
- listKickstartableChannels
- 説明
- ログインユーザーがキックスタート可能なチャンネルを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
14.17. listKickstartableTreeChannels
- 名前
- listKickstartableTreeChannels
- 説明
- ログインユーザーがキックスタート可能なツリーチャンネルを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
14.18. listKickstartableTrees
- 名前
- listKickstartableTrees
- 説明
- 指定されたチャンネルで利用可能なキックスタートツリーを一覧表示します。廃止予定 - kickstart.tree.list(string sessionKey, string channelLabel) に置換されます。
- パラメーター
- string sessionKey
- string channelLabel - 検索するチャンネルのラベル
- 戻り値
- array:
- struct - kickstartable tree
- int
id
- string
label
- string
base_path
- int
channel_id
14.19. listKickstarts
- 名前
- listKickstarts
- 説明
- ユーザー組織に見えているキックスタートプロファイルの一覧を提供します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - kickstart
- string
label
- string
tree_label
- string
name
- boolean
advanced_mode
- boolean
org_default
- boolean
active
- string
update_type
14.20. renameProfile
- 名前
- renameProfile
- 説明
- Satellite 内のキックスタートプロファイルの名前を変更します。
- パラメーター
- string sessionKey
- string originalLabel - 名前を変更するキックスタートプロファイルのラベル
- string newLabel - 変更後の新規ラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第15章 kickstart.filepreservation
概要
キックスタートファイル保持一覧を取得、操作するメソッドを提供します。
15.1. create
- 名前
- create
- 説明
- 新規のファイル保持一覧を作成します。
- パラメーター
- string session_key
- string name - 作成するファイル一覧名
- array:
- string - name - 含めるファイル名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
15.2. delete
- 名前
- delete
- 説明
- ファイル保持一覧を削除します。
- パラメーター
- string session_key
- string name - 削除するファイル一覧名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
15.3. getDetails
- 名前
- getDetails
- 説明
- 指定のファイル保持一覧に関連付けられた全データを返します。
- パラメーター
- string session_key
- string name - 詳細を取得するファイル一覧名
- 戻り値
- struct - file list
- string
name
- array
file_names
- string - name
15.4. listAllFilePreservations
- 名前
- listAllFilePreservations
- 説明
- 特定のセッションにログインしているユーザーに関連付けられている組織のファイル保持一覧すべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - file preservation
- int
id
- string
name
- dateTime.iso8601
created
- dateTime.iso8601
last_modified
第16章 kickstart.keys
概要
キックスタートキーを操作するメソッドを提供します。
16.1. create
- 名前
- create
- 説明
- 指定されたパラメーターで新規のキーを作成します。
- パラメーター
- string session_key
- string description
- string type - 有効な値は GPG または SSL
- string content
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
16.2. delete
- 名前
- delete
- 説明
- 指定されたパラメーターで特定されたキーを削除します。
- パラメーター
- string session_key
- string description
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
16.3. getDetails
- 名前
- getDetails
- 説明
- 指定のキーに関連付けられた全データを返します。
- パラメーター
- string session_key
- string description
- 戻り値
- struct - key
- string
description
- string
type
- string
content
16.4. listAllKeys
- 名前
- listAllKeys
- 説明
- 特定のセッションにログインしているユーザーに関連付けられている組織のキーすべてを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - key
- string
description
- string
type
16.5. update
- 名前
- update
- 説明
- 説明で特定されるキーのタイプとコンテンツを更新します。
- パラメーター
- string session_key
- string description
- string type - 有効な値は GPG または SSL
- string content
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第17章 kickstart.profile.keys
概要
キックスタートプロファイルに関連付けられているアクティベーションキーの一覧にアクセス、修正するメソッドを提供します。
17.1. addActivationKey
- 名前
- addActivationKey
- 説明
- キックスタートプロファイルにアクティベーションキー関連を追加します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string key - アクティベーションキー
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
17.2. getActivationKeys
- 名前
- getActivationKeys
- 説明
- キックスタートプロファイルに関連付けられているアクティベーションキーをルックアップします。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- 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 - (パッケージで置換される予定)
- array
packages
- struct - package
- string
name
- packageName - string
arch
- archLabel - オプション
- boolean
universal_default
- boolean
disabled
17.3. removeActivationKey
- 名前
- removeActivationKey
- 説明
- キックスタートプロファイルからアクティベーションキー関連を削除します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string key - アクティベーションキー
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第18章 kickstart.profile.software
概要
キックスタートプロファイルに関連付けられているソフトウェア一覧にアクセス、修正するメソッドを提供します。
18.1. appendToSoftwareList
- 名前
- appendToSoftwareList
- 説明
- キックスタートプロファイルにソフトウェアパッケージ一覧を追加します。重複パッケージは無視されます。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string[] packageList - プロファイルに追加するパッケージ名一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
18.2. getSoftwareDetails
- 名前
- getSoftwareDetails
- 説明
- キックスタートプロファイルソフトウェアの詳細を取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- struct - Kickstart packages info
- string
noBase
- @Base パッケージグループをインストール - string
ignoreMissing
- 見つからないパッケージを無視
18.3. getSoftwareList
- 名前
- getSoftwareList
- 説明
- キックスタートプロファイルのソフトウェアパッケージ一覧を取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- string[] - キックスタートプロファイルのソフトウェアパッケージ一覧を取得します。
18.4. setSoftwareDetails
- 名前
- setSoftwareDetails
- 説明
- キックスタートプロファイルソフトウェアの詳細を設定します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- struct - Kickstart packages info
- string
noBase
- @Base パッケージグループをインストール - string
ignoreMissing
- 見つからないパッケージを無視
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
18.5. setSoftwareList
- 名前
- setSoftwareList
- 説明
- キックスタートプロファイルのソフトウェアパッケージ一覧を設定します
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string[] packageList - プロファイルに設定するパッケージ名一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
18.6. setSoftwareList
- 名前
- setSoftwareList
- 説明
- キックスタートプロファイルのソフトウェアパッケージ一覧を設定します
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string[] packageList - プロファイルに設定するパッケージ名一覧
- boolean ignoremissing - true だと、見つからないパッケージは無視します
- boolean nobase - true だと @Base パッケージグループをインストールしません
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第19章 kickstart.profile.system
概要
キックスタートプロファイルの各種プロパティーを設定するメソッドを提供します。
19.1. addFilePreservations
- 名前
- addFilePreservations
- 説明
- 指定されたキックスタートプロファイルにファイル保持一覧を追加します。
- パラメーター
- string sessionKey
- string kickstartLabel
- array:
- string - filePreservations
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.2. addKeys
- 名前
- addKeys
- 説明
- 指定されたキックスタートプロファイルにキー一覧を追加します。
- パラメーター
- string sessionKey
- string kickstartLabel
- array:
- string - keyDescription
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.3. checkConfigManagement
- 名前
- checkConfigManagement
- 説明
- キックスタートプロファイルの設定管理ステータスを確認します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- boolean enabled - 設定管理が有効な場合は true、それ以外は false
19.4. checkRemoteCommands
- 名前
- checkRemoteCommands
- 説明
- キックスタートプロファイルのリモートコマンドステータスフラグを確認します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- boolean enabled - リモートコマンドのサポートが有効な場合は true、それ以外は false
19.5. disableConfigManagement
- 名前
- disableConfigManagement
- 説明
- キックスタートプロファイル内の設定管理フラグを無効にすることで、このプロファイルを使用して作成されたシステムの設定ができないようにします。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.6. disableRemoteCommands
- 名前
- disableRemoteCommands
- 説明
- キックスタートプロファイル内のリモートコマンドフラグを無効にすることで、このプロファイルを使用して作成されたシステムがリモートコマンドを実行できないようにします。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.7. enableConfigManagement
- 名前
- enableConfigManagement
- 説明
- キックスタートプロファイル内の設定管理フラグを有効にすることで、このプロファイルを使用して作成されたシステムの設定を可能にします。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.8. enableRemoteCommands
- 名前
- enableRemoteCommands
- 説明
- キックスタートプロファイル内のリモートコマンドフラグを有効にすることで、このプロファイルを使用して作成されたシステムがリモートコマンドを実行できるようにします。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.9. getLocale
- 名前
- getLocale
- 説明
- キックスタートプロファイル用のロケールを取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- struct - locale info
- string
locale
- boolean
useUtc
- true - ハードウェアクロックは UTC を使用します
- false - ハードウェアクロックは UTC を使用しません
19.10. getPartitioningScheme
- 名前
- getPartitioningScheme
- 説明
- キックスタートプロファイル用にパーティション設定スキームを取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- string[] - パーティション、論理ボリューム、およびボリュームグループの設定に使用されるパーティション設定コマンド一覧
19.11. getRegistrationType
- 名前
- getRegistrationType
- 説明
- 指定したキックスタートプロファイルの登録タイプを返します。登録タイプは、reactivation、deletion、none のいずれかです。これらのタイプは、このプロファイルを再プロビジョニングに使用する際の登録動作を決定します。
- パラメーター
- string sessionKey
- string kickstartLabel
- 戻り値
- string registrationType
- reactivation
- deletion
- none
19.12. getSELinux
- 名前
- getSELinux
- 説明
- キックスタートプロファイルの SELinux 強制モード属性を取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- string enforcingMode
- enforcing
- permissive
- disabled
19.13. listFilePreservations
- 名前
- listFilePreservations
- 説明
- 指定したキックスタートプロファイルに関連するすべてのファイル保持セットを返します。
- パラメーター
- string sessionKey
- string kickstartLabel
- 戻り値
- array:
- struct - file list
- string
name
- array
file_names
- string - name
19.14. listKeys
- 名前
- listKeys
- 説明
- 指定したキックスタートプロファイルに関連するすべてのキーセットを返します。
- パラメーター
- string sessionKey
- string kickstartLabel
- 戻り値
- array:
- struct - key
- string
description
- string
type
- string
content
19.15. removeFilePreservations
- 名前
- removeFilePreservations
- 説明
- 指定されたキックスタートプロファイルから特定のファイル保持一覧を削除します。
- パラメーター
- string sessionKey
- string kickstartLabel
- array:
- string - filePreservations
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.16. removeKeys
- 名前
- removeKeys
- 説明
- 指定されたキックスタートプロファイルから特定のキー一覧を削除します。
- パラメーター
- string sessionKey
- string kickstartLabel
- array:
- string - keyDescription
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.17. setLocale
- 名前
- setLocale
- 説明
- キックスタートプロファイルのロケールを設定します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string locale - the locale
- boolean useUtc
- true - ハードウェアクロックは UTC を使用します
- false - ハードウェアクロックは UTC を使用しません
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.18. setPartitioningScheme
- 名前
- setPartitioningScheme
- 説明
- キックスタートプロファイル用にパーティション設定スキームを設定します。
- パラメーター
- string sessionKey
- string ksLabel - 更新するキックスタートプロファイルのラベル
- string[] scheme - パーティション設定スキームは、パーティション、論理ボリューム、およびボリュームグループの設定に使用されるパーティション設定コマンド一覧です。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.19. setRegistrationType
- 名前
- setRegistrationType
- 説明
- 指定したキックスタートプロファイルの登録タイプを設定します。登録タイプは、reactivation、deletion、none のいずれかです。これらのタイプは、このプロファイルを使用する際の再登録動作を決定します。
- パラメーター
- string sessionKey
- string kickstartLabel
- string registrationType
- reactivation - 再アクティベーションキーの生成を試行し、システムの再プロビジョニング時にそれを使ってシステムを登録します。
- deletion - 既存のシステムプロファイルの削除を試行し、再プロビジョニングされたシステムを新規システムとして再登録します。
- none - 現状を保存し、現行システムを再プロビジョニング上に複製として残します。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
19.20. setSELinux
- 名前
- setSELinux
- 説明
- キックスタートプロファイルの SELinux 強制モード属性を設定し、このプロファイルを使用して作成されたシステムに適切な SELinux 強制モードを設定します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- string enforcingMode - SELinux 強制モード
- enforcing
- permissive
- disabled
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第20章 kickstart.profile
概要
キックスタートプロファイルの要素にアクセス、修正するメソッドを提供します。
20.1. addIpRange
- 名前
- addIpRange
- 説明
- キックスタートプロファイルに IP 範囲を追加します。
- パラメーター
- string sessionKey
- string label - キックスタートのラベル
- string min - IP 範囲の最小値となる IP アドレス (例: 192.168.0.1)
- string max - IP 範囲の最大値となる IP アドレス (例: 192.168.0.254)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.2. addScript
- 名前
- addScript
- 説明
- 事前/事後スクリプトをキックスタートプロファイルに追加します。
- パラメーター
- string sessionKey
- string ksLabel - スクリプトの追加先となるキックスタートラベル
- string name - キックスタートスクリプト名
- string contents - 追加する完全スクリプト
- string interpreter - 使用するインタープリターへのパス (例: /bin/bash)。空の文字列はキックスタートのデフォルトインタープリターを使用します。
- string type - スクリプトのタイプ ('pre' または 'post')
- boolean chroot - chroot インストールの場所でスクリプトを実行する (推奨) かどうか
- 戻り値
- int id - 追加したスクリプトの ID
20.3. addScript
- 名前
- addScript
- 説明
- 事前/事後スクリプトをキックスタートプロファイルに追加します。
- パラメーター
- string sessionKey
- string ksLabel - スクリプトの追加先となるキックスタートラベル
- string name - キックスタートスクリプト名
- string contents - 追加する完全スクリプト
- string interpreter - 使用するインタープリターへのパス (例: /bin/bash)。空の文字列はキックスタートのデフォルトインタープリターを使用します。
- string type - スクリプトのタイプ ('pre' または 'post')
- boolean chroot - chroot インストールの場所でスクリプトを実行する (推奨) かどうか
- boolean template - cobbler を使用したテンプレートの有効化
- 戻り値
- int id - 追加したスクリプトの ID
20.4. addScript
- 名前
- addScript
- 説明
- 事前/事後スクリプトをキックスタートプロファイルに追加します。
- パラメーター
- string sessionKey
- string ksLabel - スクリプトの追加先となるキックスタートラベル
- string name - キックスタートスクリプト名
- string contents - 追加する完全スクリプト
- string interpreter - 使用するインタープリターへのパス (例: /bin/bash)。空の文字列はキックスタートのデフォルトインタープリターを使用します。
- string type - スクリプトのタイプ ('pre' または 'post')
- boolean chroot - chroot インストールの場所でスクリプトを実行する (推奨) かどうか
- boolean template - cobbler を使用したテンプレートの有効化
- boolean erroronfail - スクリプトが失敗した場合にエラーをスローするかどうか
- 戻り値
- int id - 追加したスクリプトの ID
20.5. compareActivationKeys
- 名前
- compareActivationKeys
- 説明
- 各キックスタートプロファイルに一覧を返します。各一覧には、他のプロファイルにないアクティベーションキーが含まれます。
- パラメーター
- string sessionKey
- string kickstartLabel1
- string kickstartLabel2
- 戻り値
- struct - Comparison Info
- array
kickstartLabel1
- 最初のキックスタートプロファイルの実際のラベルが構造体へのキーになります - 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 - (パッケージで置換される予定)
- array
packages
- struct - package
- string
name
- packageName - string
arch
- archLabel - オプション
- boolean
universal_default
- boolean
disabled
- array
kickstartLabel2
- 2 番目のキックスタートプロファイルの実際のラベルが構造体へのキーになります - 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 - (パッケージで置換される予定)
- array
packages
- struct - package
- string
name
- packageName - string
arch
- archLabel - オプション
- boolean
universal_default
- boolean
disabled
20.6. compareAdvancedOptions
- 名前
- compareAdvancedOptions
- 説明
- 各キックスタートプロファイルに一覧を返します。各一覧には、プロファイルで異なる属性と、そのプロファイルでの値が含まれます。
- パラメーター
- string sessionKey
- string kickstartLabel1
- string kickstartLabel2
- 戻り値
- struct - Comparison Info
- array
kickstartLabel1
- 最初のキックスタートプロファイルの実際のラベルが構造体へのキーになります - array:
- struct - value
- string
name
- string
value
- boolean
enabled
- array
kickstartLabel2
- 2 番目のキックスタートプロファイルの実際のラベルが構造体へのキーになります - array:
- struct - value
- string
name
- string
value
- boolean
enabled
20.7. comparePackages
- 名前
- comparePackages
- 説明
- 各キックスタートプロファイルに一覧を返します。各一覧には、他のプロファイルにないパッケージ名が含まれます。
- パラメーター
- string sessionKey
- string kickstartLabel1
- string kickstartLabel2
- 戻り値
- struct - Comparison Info
- array
kickstartLabel1
- 最初のキックスタートプロファイルの実際のラベルが構造体へのキーになります - array:
- string - パッケージ名
- array
kickstartLabel2
- 2 番目のキックスタートプロファイルの実際のラベルが構造体へのキーになります - array:
- string - パッケージ名
20.8. downloadKickstart
- 名前
- downloadKickstart
- 説明
- キックスタートファイルの完全コンテンツをダウンロードします
- パラメーター
- string sessionKey
- string ksLabel - ダウンロードするキックスタートのラベル
- string host - Satellite 自体を参照する際に使用するホスト。(通常これは Satellite の FQDN になりますが、IP アドレスや短い名前となる場合もあります)
- 戻り値
- string - キックスタートファイルのコンテンツ。キックスタートファイルにアクティベーションキーが関連付けられていない場合は、Satellite が生成した %post セクションでは登録がなされません。関連付けられていると、登録に使用されます。
20.9. downloadRenderedKickstart
- 名前
- downloadRenderedKickstart
- 説明
- Cobbler レンダリングのキックスタートファイルをダウンロードします。
- パラメーター
- string sessionKey
- string ksLabel - ダウンロードするキックスタートのラベル
- 戻り値
- string - キックスタートファイルのコンテンツ
20.10. getAdvancedOptions
- 名前
- getAdvancedOptions
- 説明
- キックスタートプロファイル用の高度なオプションを取得します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- 戻り値
- array:
- struct - option
- string
name
- string
arguments
20.11. getAvailableRepositories
- 名前
- getAvailableRepositories
- 説明
- キックスタートプロファイルに関連付ける、利用可能な OS リポジトリーを一覧表示します。
- パラメーター
- string sessionKey
- string ksLabel
- 戻り値
- array:
- string - repositoryLabel
20.12. getCfgPreservation
- 名前
- getCfgPreservation
- 説明
- キックスタートプロファイル用の ks.cfg 保存オプションを取得します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- 戻り値
- boolean - オプションの値。True の場合は ks.cfg が /root にコピーされ、False の場合はコピーされません。
20.13. getChildChannels
- 名前
- getChildChannels
- 説明
- キックスタートプロファイル用の子チャンネルを取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- array:
- string - channelLabel
20.14. getCustomOptions
- 名前
- getCustomOptions
- 説明
- キックスタートプロファイル用のカスタムオプションを取得します。
- パラメーター
- string sessionKey
- string ksLabel
- 戻り値
- array:
- struct - option
- int
id
- string
arguments
20.15. getKickstartTree
- 名前
- getKickstartTree
- 説明
- キックスタートプロファイルのキックスタートツリーを取得します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- 戻り値
- string kstreeLabel - キックスタートツリーのラベル
20.16. getRepositories
- 名前
- getRepositories
- 説明
- キックスタートプロファイルに関連付けられた OS リポジトリーすべてを一覧表示します。
- パラメーター
- string sessionKey
- string ksLabel
- 戻り値
- array:
- string - repositoryLabel
20.17. getUpdateType
- 名前
- getUpdateType
- 説明
- キックスタートプロファイルの更新タイプを取得します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートプロファイルのラベル
- 戻り値
- string update_type - キックスタートプロファイルの更新タイプ
20.18. getVariables
- 名前
- getVariables
- 説明
- 指定したキックスタートプロファイルに関連付けられている変数一覧を返します。
- パラメーター
- string sessionKey
- string ksLabel
- 戻り値
- struct - kickstart variable
- string
key
- string または int
value
20.19. getVirtualizationType
- 名前
- getVirtualizationType
- 説明
- 指定したキックスタートプロファイルラベルに、使用している仮想化タイプのラベルを返します。
- パラメーター
- string sessionKey
- string ksLabel
- 戻り値
- string virtLabel - 仮想化タイプのラベル
20.20. listIpRanges
- 名前
- listIpRanges
- 説明
- キックスタートプロファイルの全 IP 範囲を一覧表示します。
- パラメーター
- string sessionKey
- string label - キックスタートのラベル
- 戻り値
- array:
- struct - Kickstart Ip Range
- string
ksLabel
- IP 範囲に関連付けられているキックスタートのラベル - string
max
- IP 範囲の最大値 - string
min
- IP 範囲の最小値
20.21. listScripts
- 名前
- listScripts
- 説明
- キックスタート中に実行される順序で、キックスタートプロファイルの事前および事後スクリプトを一覧表示します。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートのラベル
- 戻り値
- array:
- struct - kickstart script
- int
id
- string
name
- string
contents
- string
script_type
- スクリプトのタイプ (事前または事後) - string
interpreter
- このスクリプトに使用するスクリプト言語インタープリター。空の文字列の場合は、デフォルトのキックスタートシェルを表します。 - boolean
chroot
- chroot 環境内でスクリプトを実行する場合は True - boolean
erroronfail
- 失敗時にスクリプトがエラーをスローする場合は True - boolean
template
- cobbler を使用したテンプレートが有効な場合は True - boolean
beforeRegistration
- サーバー登録前かつサーバーアクションの実行前にスクリプトを実行する場合は True
20.22. orderScripts
- 名前
- orderScripts
- 説明
- キックスタートプロファイルにおけるキックスタートスクリプトの実行順序を変更します。スクリプトは、アレイに表示される順序で実行されます。アレイは 3 つあり、すべて事前スクリプトのアレイ、登録前およびサーバーアクション前に実行される事後スクリプトのアレイ、登録後およびサーバーアクション後に実行される事後スクリプトのアレイになります。スクリプトはすべて、これらのいずれかに含まれる必要があります。
- パラメーター
- string sessionKey
- string ksLabel - キックスタートのラベル
- array:
- int - 順序付けされた事前スクリプトの ID
- array:
- int - 登録前に実行される、順序付けされた事後スクリプトの ID
- array:
- int - 登録後に実行される、順序付けされた事後スクリプトの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.23. removeIpRange
- 名前
- removeIpRange
- 説明
- キックスタートプロファイルから IP 範囲を削除します。
- パラメーター
- string sessionKey
- string ksLabel - 削除する IP 範囲のキックスタートラベル
- string ip_address - 削除する IP 範囲に該当する IP アドレス。範囲の最大値と最小値は機能します。
- 戻り値
- int - 削除に成功すると 1、指定したキックスタートの範囲が見つからない場合は 0、それ以外は例外。
20.24. removeScript
- 名前
- removeScript
- 説明
- キックスタートプロファイルからスクリプトを削除します。
- パラメーター
- string sessionKey
- string ksLabel - 削除するスクリプトがあるキックスタート
- int scriptId - 削除するスクリプトの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.25. setAdvancedOptions
- 名前
- setAdvancedOptions
- 説明
- キックスタートプロファイルの高度なオプションを設定します。'md5_crypt_rootpw' を 'True' に設定すると、'root_pw' はプレーンテキストとして受け取られ、サーバー側で md5 暗号化されます。それ以外の場合は、ハッシュ暗号化されたパスワード (auth オプションに準拠) が予想されます
- パラメーター
- string sessionKey
- string ksLabel
- array:
- struct - advanced options
- string
name
- 高度なオプションの名前。有効なオプション名は以下のとおり。autostep, interactive, install, upgrade, text, network, cdrom, harddrive, nfs, url, lang, langsupport keyboard, mouse, device, deviceprobe, zerombr, clearpart, bootloader, timezone, auth, rootpw, selinux, reboot, firewall, xconfig, skipx, key, ignoredisk, autopart, cmdline, firstboot, graphical, iscsi, iscsiname, logging, monitor, multipath, poweroff, halt, services, shutdown, user, vnc, zfcp, driverdisk, md5_crypt_rootpw - string
arguments
- オプションの引数
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.26. setCfgPreservation
- 名前
- setCfgPreservation
- 説明
- キックスタートプロファイル用の ks.cfg 保存オプションを設定します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- boolean preserve - ks.cfg とすべての %include フラグメントが /root にコピーされるかどうか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.27. setChildChannels
- 名前
- setChildChannels
- 説明
- キックスタートプロファイル用の子チャンネルを設定します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- string[] channelLabels - 子チャンネルのラベル一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.28. setCustomOptions
- 名前
- setCustomOptions
- 説明
- キックスタートプロファイル用のカスタムオプションを設定します。
- パラメーター
- string sessionKey
- string ksLabel
- string[] options
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.29. setKickstartTree
- 名前
- setKickstartTree
- 説明
- キックスタートプロファイルのキックスタートツリーを設定します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- string kstreeLabel - 新規キックスタートツリーのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.30. setLogging
- 名前
- setLogging
- 説明
- キックスタートプロファイル用のログオプションを設定します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- boolean pre - /root/ks-pre.log にキックスタートの事前セクションをログ記録するかどうか
- boolean post - /root/ks-post.log にキックスタートの事後セクションをログ記録するかどうか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.31. setRepositories
- 名前
- setRepositories
- 説明
- $call.doc
- パラメーター
- string sessionKey
- string ksLabel
- array:
- string - repositoryLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.32. setUpdateType
- 名前
- setUpdateType
- 説明
- キックスタートプロファイル用の更新タイプを設定します。
- パラメーター
- string sessionKey
- string ksLabel - 変更するキックスタートプロファイルのラベル
- string updateType - 設定する新規更新タイプ。可能な値は、'red_hat'、'all'、'none' のいずれか。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.33. setVariables
- 名前
- setVariables
- 説明
- キックスタート変更一覧を指定したキックスタートプロファイルに関連付けます。
- パラメーター
- string sessionKey
- string ksLabel
- struct - kickstart variable
- string
key
- string または int
value
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
20.34. setVirtualizationType
- 名前
- setVirtualizationType
- 説明
- 指定したキックスタートプロファイルラベルに、仮想化タイプ設定します。
- パラメーター
- string sessionKey
- string ksLabel
- string typeLabel - 'none', 'qemu', 'para_host', 'xenpv', 'xenfv' のいずれか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第21章 kickstart.snippet
概要
キックスタートファイルを作成するメソッドを提供します。
21.1. createOrUpdate
- 名前
- createOrUpdate
- 説明
- 存在しない場合は、指定して名前とコンテンツでスニペットを作成します。存在する場合は、既存のスニペットが更新されます。
- パラメーター
- string sessionKey
- string name
- string contents
- 戻り値
- struct - snippet
- string
name
- string
contents
- string
fragment
- スニペットを生成するキックスタートファイルに含まれる文字列 - string
file
- スニペットを含むファイルへのローカルパス
21.2. delete
- 名前
- delete
- 説明
- 指定したスニペットを削除します。スニペットが見つからない場合は、0 を返します。
- パラメーター
- string sessionKey
- string name
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
21.3. listAll
- 名前
- listAll
- 説明
- 現在ログインしているユーザーの全 cobbler スニペットを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - snippet
- string
name
- string
contents
- string
fragment
- スニペットを生成するキックスタートファイルに含まれる文字列 - string
file
- スニペットを含むファイルへのローカルパス
21.4. listCustom
- 名前
- listCustom
- 説明
- 現在ログインしているユーザーのカスタムスニペットのみを一覧表示します。このスニペットは編集可能です。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - snippet
- string
name
- string
contents
- string
fragment
- スニペットを生成するキックスタートファイルに含まれる文字列 - string
file
- スニペットを含むファイルへのローカルパス
21.5. listDefault
- 名前
- listDefault
- 説明
- 現在ログインしているユーザーの事前作成されたデフォルトのスニペットのみを一覧表示します。このスニペットは編集できません。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - snippet
- string
name
- string
contents
- string
fragment
- スニペットを生成するキックスタートファイルに含まれる文字列 - string
file
- スニペットを含むファイルへのローカルパス
第22章 kickstart.tree
概要
キックスタートツリーにアクセス、修正するメソッドを提供します。
22.1. create
- 名前
- create
- 説明
- Satellite 内にキックスタートツリー (ディストリビューション) を作成します。
- パラメーター
- string sessionKey
- string treeLabel - 新規のキックスタートツリーラベル
- string basePath - キックスタートツリーのベースまたは root へのパス
- string channelLabel - キックスタートツリーに関連付けるチャンネルのラベル
- string installType - KickstartInstallType のラベル (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
22.2. delete
- 名前
- delete
- 説明
- Satellite 内のキックスタートツリー (ディストリビューション) を削除します。
- パラメーター
- string sessionKey
- string treeLabel - 削除するキックスタートツリーラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
22.3. deleteTreeAndProfiles
- 名前
- deleteTreeAndProfiles
- 説明
- キックスタートツリーとそれに関連付けられているすべてのプロファイルを削除します。警告: このキックスタートツリーに関連付けられているすべてのプロファイルが削除されます!
- パラメーター
- string sessionKey
- string treeLabel - 削除するキックスタートツリーラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
22.4. getDetails
- 名前
- getDetails
- 説明
- 指定したツリー名であるキックスタート可能なツリーについての詳細情報
- パラメーター
- string sessionKey
- string treeLabel - 検索するキックスタート可能なツリーのラベル
- 戻り値
- struct - kickstartable tree
- int
id
- string
label
- string
abs_path
- int
channel_id
- struct - kickstart install type
- int
id
- string
label
- string
name
22.5. list
- 名前
- list
- 説明
- 指定されたチャンネルで利用可能なキックスタート可能なツリーを一覧表示します。
- パラメーター
- string sessionKey
- string channelLabel - 検索するチャンネルのラベル
- 戻り値
- array:
- struct - kickstartable tree
- int
id
- string
label
- string
base_path
- int
channel_id
22.6. listInstallTypes
- 名前
- listInstallTypes
- 説明
- 利用可能なキックスタート可能なインストールタイプ (rhel2,3,4,5 および fedora9+) を一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - kickstart install type
- int
id
- string
label
- string
name
22.7. rename
- 名前
- rename
- 説明
- Satellite 内のキックスタートツリー (ディストリビューション) の名前を変更します。
- パラメーター
- string sessionKey
- string originalLabel - 名前を変更するキックスタートツリーラベル
- string newLabel - キックスタートツリーの新規ラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
22.8. update
- 名前
- update
- 説明
- Satellite 内のキックスタートツリー (ディストリビューション) を編集します。
- パラメーター
- string sessionKey
- string treeLabel - キックスタートツリーラベル
- string basePath - キックスタートツリーのベースまたは root へのパス
- string channelLabel - キックスタートツリーに関連付けるチャンネルのラベル
- string installType - KickstartInstallType のラベル (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第23章 org
概要
Web インターフェイスから利用可能な一般的な組織管理関数にアクセスするメソッドです。
23.1. create
- 名前
- create
- 説明
- 新規の組織および関連する管理者アカウントを作成します。
- パラメーター
- string sessionKey
- string orgName - 組織名。Web UI の場合と同じ条件を満たす必要があります。
- string adminLogin - 新規管理者のログイン名
- string adminPassword - 新規管理者のパスワード
- string prefix - 新規管理者の敬称。Web UI で利用可能な値 (Dr., Mr., Mrs., Sr., など) のいずれかに一致する必要があります。
- string firstName - 新規管理者のファーストネーム
- string lastName - 新規管理者の苗字
- string email - 新規管理者の E メール
- boolean usePamAuth - 新規管理者のアカウントに PAM 認証を使用する場合は True
- 戻り値
- struct - organization info
- int
id
- string
name
- int
active_users
- 組織内のアクティブなユーザー数 - int
systems
- 組織内のシステム数 - int
trusts
- 信頼できる組織数 - int
system_groups
- 組織内のシステムグループ数 (オプション) - int
activation_keys
- 組織内のアクティブキーの数 (オプション) - int
kickstart_profiles
- 組織内のキックスタートプロファイル数 (オプション) - int
configuration_channels
- 組織内の設定チャンネル数 (オプション) - boolean
staging_content_enabled
- ステージングしているコンテンツが組織内で有効になっているかどうか (オプション)
23.2. delete
- 名前
- delete
- 説明
- 組織を削除します。デフォルトの組織 (例: orgId=1) は削除できません。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.3. getCrashFileSizeLimit
- 名前
- getCrashFileSizeLimit
- 説明
- 組織全体でのクラッシュファイルのサイズ制限を取得します。制限値はマイナスでない数値である必要があり、ゼロの場合は制限なしとなります。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- int - クラッシュファイルのサイズ制限
23.4. getDetails
- 名前
- getDetails
- 説明
- 指定した組織 ID の組織についての詳細情報
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- struct - organization info
- int
id
- string
name
- int
active_users
- 組織内のアクティブなユーザー数 - int
systems
- 組織内のシステム数 - int
trusts
- 信頼できる組織数 - int
system_groups
- 組織内のシステムグループ数 (オプション) - int
activation_keys
- 組織内のアクティブキーの数 (オプション) - int
kickstart_profiles
- 組織内のキックスタートプロファイル数 (オプション) - int
configuration_channels
- 組織内の設定チャンネル数 (オプション) - boolean
staging_content_enabled
- ステージングしているコンテンツが組織内で有効になっているかどうか (オプション)
23.5. getDetails
- 名前
- getDetails
- 説明
- 指定した組織名の組織についての詳細情報
- パラメーター
- string sessionKey
- string name
- 戻り値
- struct - organization info
- int
id
- string
name
- int
active_users
- 組織内のアクティブなユーザー数 - int
systems
- 組織内のシステム数 - int
trusts
- 信頼できる組織数 - int
system_groups
- 組織内のシステムグループ数 (オプション) - int
activation_keys
- 組織内のアクティブキーの数 (オプション) - int
kickstart_profiles
- 組織内のキックスタートプロファイル数 (オプション) - int
configuration_channels
- 組織内の設定チャンネル数 (オプション) - boolean
staging_content_enabled
- ステージングしているコンテンツが組織内で有効になっているかどうか (オプション)
23.6. getPolicyForScapFileUpload
- 名前
- getPolicyForScapFileUpload
- 説明
- 指定した組織の SCAP 詳細結果ファイルのアップロード設定についてのステータスを取得します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- struct - scap_upload_info
- boolean
enabled
- 詳細な SCAP 結果の集約が有効になります。 - int
size_limit
- 単一 SCAP ファイルアップロードの制限 (バイト単位)
23.7. getPolicyForScapResultDeletion
- 名前
- getPolicyForScapResultDeletion
- 説明
- 指定した組織の SCAP 結果削除設定についてのステータスを取得します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- struct - scap_deletion_info
- boolean
enabled
- SCAP 結果の削除が有効になります。 - int
retention_period
- (有効になっている場合) スキャンが削除可能になるまでの期間 (日数)
23.8. isCrashReportingEnabled
- 名前
- isCrashReportingEnabled
- 説明
- 指定した組織のクラッシュレポート設定のステータスを取得します。有効な場合は true を、それ以外の場合は false を返します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- boolean - クラッシュレポート設定のステータスを取得します。
23.9. isCrashfileUploadEnabled
- 名前
- isCrashfileUploadEnabled
- 説明
- 指定した組織のクラッシュファイルアップロード設定のステータスを取得します。有効な場合は true を、それ以外の場合は false を返します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- boolean - クラッシュファイルのアップロード設定のステータスを取得します。
23.10. isErrataEmailNotifsForOrg
- 名前
- isErrataEmailNotifsForOrg
- 説明
- 組織にエラータ E メール通知が有効になっているかどうかを返します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- boolean - 組織のエラータ E メール通知設定のステータスを返します。
23.11. isOrgConfigManagedByOrgAdmin
- 名前
- isOrgConfigManagedByOrgAdmin
- 説明
- 組織管理者が組織設定を管理できるかどうかを返します。この組織設定は、Spacewalk/Satellite のパフォーマンス全体に影響する可能性があります。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- boolean - 組織管理者管理設定のステータスを返します。
23.12. listOrgs
- 名前
- listOrgs
- 説明
- 組織一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - organization info
- int
id
- string
name
- int
active_users
- 組織内のアクティブなユーザー数 - int
systems
- 組織内のシステム数 - int
trusts
- 信頼できる組織数 - int
system_groups
- 組織内のシステムグループ数 (オプション) - int
activation_keys
- 組織内のアクティブキーの数 (オプション) - int
kickstart_profiles
- 組織内のキックスタートプロファイル数 (オプション) - int
configuration_channels
- 組織内の設定チャンネル数 (オプション) - boolean
staging_content_enabled
- ステージングしているコンテンツが組織内で有効になっているかどうか (オプション)
23.13. listSoftwareEntitlements
- 名前
- listSoftwareEntitlements
- 説明
- 組織全体のソフトウェアエンタイトルメント割り当て情報を一覧表示します。発信者は satellite 管理者である必要があります。
- パラメーター
- string sessionKey
- 戻り値
- 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
23.14. listSoftwareEntitlements
- 名前
- listSoftwareEntitlements
- 説明
- 各組織における指定したソフトウェアエンタイトルメントの割り当てを一覧表示します。割り当てがない組織は一覧に表示されません。値が -1 の場合は、無制限のエンタイトルメントを意味します。廃止予定 - listSoftwareEntitlements(string sessionKey, string label, boolean includeUnentitled) に置換されます。
- パラメーター
- string sessionKey
- string label - ソフトウェアのエンタイトルメントラベル
- 戻り値
- array:
- struct - entitlement usage
- int
org_id
- string
org_name
- int
allocated
- int
unallocated
- int
used
- int
free
23.15. listSoftwareEntitlements
- 名前
- listSoftwareEntitlements
- 説明
- 各組織における指定したソフトウェアエンタイトルメントの割り当てを一覧表示します。値が -1 の場合は、無制限のエンタイトルメントを意味します。利用可能バージョン: 10.4 以降
- パラメーター
- string sessionKey
- string label - ソフトウェアのエンタイトルメントラベル
- boolean includeUnentitled - true の場合は、エンタイトルメントがある組織とない組織の両方が結果に含まれます。それ以外の場合は、エンタイトルメントがある組織のみが結果に含まれます。
- 戻り値
- array:
- struct - entitlement usage
- int
org_id
- string
org_name
- int
allocated
- int
unallocated
- int
used
- int
free
23.16. listSoftwareEntitlementsForOrg
- 名前
- listSoftwareEntitlementsForOrg
- 説明
- 組織における各ソフトウェアエンタイトルメントの割り当てを一覧表示します。値が -1 の場合は、無制限のエンタイトルメントを意味します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- 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
23.17. listSystemEntitlements
- 名前
- listSystemEntitlements
- 説明
- 組織全体のシステムエンタイトルメント割り当て情報を一覧表示します。発信者は satellite 管理者である必要があります。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - entitlement usage
- string
label
- string
name
- int
allocated
- int
unallocated
- int
used
- int
free
23.18. listSystemEntitlements
- 名前
- listSystemEntitlements
- 説明
- 各組織におけるシステムエンタイトルメントの割り当てを一覧表示します。組織に特定のエンタイトルメントが割り当てられていない場合は、一覧に表示されません。廃止予定 - listSystemEntitlements(string sessionKey, string label, boolean includeUnentitled) に置換されます。
- パラメーター
- string sessionKey
- string label
- 戻り値
- array:
- struct - entitlement usage
- int
org_id
- string
org_name
- int
allocated
- int
unallocated
- int
used
- int
free
23.19. listSystemEntitlements
- 名前
- listSystemEntitlements
- 説明
- 各組織におけるシステムエンタイトルメントの割り当てを一覧表示します。利用可能バージョン: 10.4 以降
- パラメーター
- string sessionKey
- string label
- boolean includeUnentitled - true の場合は、エンタイトルメントがある組織とない組織の両方が結果に含まれます。それ以外の場合は、エンタイトルメントがある組織のみが結果に含まれます。
- 戻り値
- array:
- struct - entitlement usage
- int
org_id
- string
org_name
- int
allocated
- int
unallocated
- int
used
- int
free
23.20. listSystemEntitlementsForOrg
- 名前
- listSystemEntitlementsForOrg
- 説明
- 組織における各システムエンタイトルメントの割り当てを一覧表示します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- array:
- struct - entitlement usage
- string
label
- string
name
- int
free
- int
used
- int
allocated
- int
unallocated
23.21. listUsers
- 名前
- listUsers
- 説明
- 指定した組織内のユーザー一覧を返します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- array:
- struct - user
- string
login
- string
login_uc
- string
name
- string
email
- boolean
is_org_admin
23.22. migrateSystems
- 名前
- migrateSystems
- 説明
- ある組織から別の組織にシステムを移行します。Satellite 管理者が実行する場合は、現行組織から toOrgId で指定した組織に移行されます。組織管理者が実行する場合は、管理者と同じ組織にシステムが存在する必要があり、toOrgId で指定した組織に移行されます。どのシナリオでも、元の組織と移行先の組織は信頼関係で定義されている必要があります。
- パラメーター
- string sessionKey
- int toOrgId - システムの移行先となる組織の ID
- array:
- int - systemId
- 戻り値
- array:
- int - serverIdMigrated
23.23. setCrashFileSizeLimit
- 名前
- setCrashFileSizeLimit
- 説明
- 組織全体でのクラッシュファイルのサイズ制限を設定します。制限値はマイナスでない数値である必要があり、ゼロの場合は制限なしとなります。
- パラメーター
- string sessionKey
- int orgId
- int limit - 設定する制限値 (マイナス以外の値)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.24. setCrashReporting
- 名前
- setCrashReporting
- 説明
- 指定した組織のクラッシュレポート設定のステータスを設定します。クラッシュレポートを無効にすると、自動でクラッシュファイルのアップロードが無効になります。
- パラメーター
- string sessionKey
- int orgId
- boolean enable - true/false で有効/無効にする
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.25. setCrashfileUpload
- 名前
- setCrashfileUpload
- 説明
- 指定した組織のクラッシュファイルアップロード設定のステータスを設定します。クラッシュレポートが有効であれば、設定の変更が可能です。
- パラメーター
- string sessionKey
- int orgId
- boolean enable - true/false で有効/無効にする
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.26. setErrataEmailNotifsForOrg
- 名前
- setErrataEmailNotifsForOrg
- 説明
- 組織のエラータ E メール通知を有効、無効にします。
- パラメーター
- string sessionKey
- int orgId
- boolean enable - true/false で有効/無効にする
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.27. setOrgConfigManagedByOrgAdmin
- 名前
- setOrgConfigManagedByOrgAdmin
- 説明
- 組織管理者が組織設定を管理できるかどうかを設定します。この組織設定は、Spacewalk/Satellite のパフォーマンス全体に影響する可能性があります。
- パラメーター
- string sessionKey
- int orgId
- boolean enable - true/false で有効/無効にする
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.28. setPolicyForScapFileUpload
- 名前
- setPolicyForScapFileUpload
- 説明
- 指定した組織の SCAP 詳細結果ファイルのアップロード設定についてのステータスを設定します。
- パラメーター
- string sessionKey
- int orgId
- struct - scap_upload_info
- boolean
enabled
- 詳細な SCAP 結果の集約が有効になります。 - int
size_limit
- 単一 SCAP ファイルアップロードの制限 (バイト単位)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.29. setPolicyForScapResultDeletion
- 名前
- setPolicyForScapResultDeletion
- 説明
- 指定した組織の SCAP 結果削除設定についてのステータスを設定します。
- パラメーター
- string sessionKey
- int orgId
- struct - scap_deletion_info
- boolean
enabled
- SCAP 結果の削除が有効になります。 - int
retention_period
- (有効になっている場合) スキャンが削除可能になるまでの期間 (日数)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.30. setSoftwareEntitlements
- 名前
- setSoftwareEntitlements
- 説明
- 指定したソフトウェアエンタイトルメントについての組織のエンタイトルメント割り当てを設定します。エンタイトルメント割り当てを増やす場合は、デフォルトの組織 (orgId=1) に十分な数の空きエンタイトルメント数がある必要があります。
- パラメーター
- string sessionKey
- int orgId
- string label - ソフトウェアのエンタイトルメントラベル
- int allocation
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.31. setSoftwareFlexEntitlements
- 名前
- setSoftwareFlexEntitlements
- 説明
- 指定したソフトウェアエンタイトルメントについての組織の flex エンタイトルメント割り当てを設定します。flex エンタイトルメント割り当てを増やす場合は、デフォルトの組織 (orgId=1) に十分な数の空き flex エンタイトルメント数がある必要があります。
- パラメーター
- string sessionKey
- int orgId
- string label - ソフトウェアのエンタイトルメントラベル
- int allocation
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.32. setSystemEntitlements
- 名前
- setSystemEntitlements
- 説明
- 指定したソフトウェアエンタイトルメントについての組織のエンタイトルメント割り当てを設定します。エンタイトルメント割り当てを増やす場合は、デフォルトの組織 (orgId=1) に十分な数の空きエンタイトルメント数がある必要があります。
- パラメーター
- string sessionKey
- int orgId
- string label - システムエンタイトルメントのラベル。有効な値は以下のとおりです:
- enterprise_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- int allocation
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
23.33. updateName
- 名前
- updateName
- 説明
- 組織の名前を更新します。
- パラメーター
- string sessionKey
- int orgId
- string name - 組織名。Web UI の場合と同じ条件を満たす必要があります。
- 戻り値
- struct - organization info
- int
id
- string
name
- int
active_users
- 組織内のアクティブなユーザー数 - int
systems
- 組織内のシステム数 - int
trusts
- 信頼できる組織数 - int
system_groups
- 組織内のシステムグループ数 (オプション) - int
activation_keys
- 組織内のアクティブキーの数 (オプション) - int
kickstart_profiles
- 組織内のキックスタートプロファイル数 (オプション) - int
configuration_channels
- 組織内の設定チャンネル数 (オプション) - boolean
staging_content_enabled
- ステージングしているコンテンツが組織内で有効になっているかどうか (オプション)
第24章 org.trusts
概要
web インターフェイスから利用可能な一般的な組織の信頼情報にアクセスするメソッドが含まれています。
24.1. addTrust
- 名前
- addTrust
- 説明
- 信頼済み組織一覧に組織を追加します。
- パラメーター
- string sessionKey
- int orgId
- int trustOrgId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
24.2. getDetails
- 名前
- getDetails
- 説明
- 指定した組織 ID の組織についての信頼の詳細
- パラメーター
- string sessionKey
- int trustOrgId - 信頼済み組織の ID
- 戻り値
- struct - org trust details
- dateTime.iso8601
created
- 組織の作成日時 - dateTime.iso8601
trusted_since
- 組織が信頼済みとして定義された日時 - int
channels_provided
- 組織が提供するチャンネル数 - int
channels_consumed
- 組織が消費したチャンネル数 - int
systems_migrated_to
- 組織に移行したシステム数 - int
systems_migrated_from
- 組織から移行したシステム数
24.3. listChannelsConsumed
- 名前
- listChannelsConsumed
- 説明
- ユーザー組織から指定した組織が消費可能なソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- int trustOrgId - 信頼済み組織の ID
- 戻り値
- array:
- struct - channel info
- int
channel_id
- string
channel_name
- int
packages
- int
systems
24.4. listChannelsProvided
- 名前
- listChannelsProvided
- 説明
- ユーザー組織に指定した組織が提供しているソフトウェアチャンネルすべてを一覧表示します。
- パラメーター
- string sessionKey
- int trustOrgId - 信頼済み組織の ID
- 戻り値
- array:
- struct - channel info
- int
channel_id
- string
channel_name
- int
packages
- int
systems
24.5. listOrgs
- 名前
- listOrgs
- 説明
- ユーザー組織が信頼する全組織を一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - trusted organizations
- int
org_id
- string
org_name
- int
shared_channels
24.6. listSystemsAffected
- 名前
- listSystemsAffected
- 説明
- 信頼関係が削除された場合に信頼済み組織内で影響を受けるシステム一覧を取得します。基本的には、少なくとも 1 つのパッケージを共有しているシステムを一覧表示することになります。
- パラメーター
- string sessionKey
- int orgId
- string trustOrgId
- 戻り値
- array:
- struct - affected systems
- int
systemId
- string
systemName
24.7. listTrusts
- 名前
- listTrusts
- 説明
- 信頼済み組織一覧を返します。
- パラメーター
- string sessionKey
- int orgId
- 戻り値
- array:
- struct - trusted organizations
- int
orgId
- string
orgName
- bool
trustEnabled
24.8. removeTrust
- 名前
- removeTrust
- 説明
- 信頼済み組織一覧から組織を削除します。
- パラメーター
- string sessionKey
- int orgId
- int trustOrgId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第25章 packages
概要
サーバーに含まれているパッケージに関する情報を取得するメソッド
25.1. findByNvrea
- 名前
- findByNvrea
- 説明
- 指定して名前、バージョン、リリース、アーキテクチャーラベル、および (オプションで) エポックのパッケージ詳細をルックアップします。
- パラメーター
- string sessionKey
- string name
- string version
- string release
- string epoch - 空の文字列以外に設定すると、厳密な一致が使用され、epoch 文字列が正確である必要があります。空の文字列に設定し、epoch が null または NVRA の組み合わせが 1 つだけの場合、それが返されます (空の文字列を推奨)
- string archLabel
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
- string
path
- パッケージが格納されているファイルシステムのパス - string
provider
- パッケージのプロバイダー。署名した gpg キーで判定。 - dateTime.iso8601
last_modified
25.2. getDetails
- 名前
- getDetails
- 説明
- 指定した ID のパッケージ詳細を取得します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- struct - package
- int
id
- string
name
- string
epoch
- string
version
- string
release
- string
arch_label
- array
providing_channels
- string - このパッケージを提供しているチャンネルラベル
- 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
- パッケージが格納されている Satellite のファイルシステムのパス - string
payload_size
25.3. getPackage
- 名前
- getPackage
- 説明
- パッケージに関連付けられているパッケージファイルを取得します (大型ファイルでは packages.getPackageUrl の使用を検討してください。)
- パラメーター
- string sessionKey
- int package_id
- 戻り値
- binary object - パッケージファイル
25.4. getPackageUrl
- 名前
- getPackageUrl
- 説明
- パッケージのダウンロードに使用可能な url を取得します。これは一定期間後に無効になります。
- パラメーター
- string sessionKey
- int package_id
- 戻り値
- string - ダウンロードの url
25.5. listChangelog
- 名前
- listChangelog
- 説明
- パッケージの変更ログを一覧表示します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- string
25.6. listDependencies
- 名前
- listDependencies
- 説明
- パッケージの依存関係を一覧表示します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- array:
- struct - dependency
- string
dependency
- string
dependency_type
- 以下のいずれか: - requires
- conflicts
- obsoletes
- provides
- recommends
- suggests
- supplements
- enhances
- string
dependency_modifier
25.7. listFiles
- 名前
- listFiles
- 説明
- パッケージに関連付けられているファイルを一覧表示します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- array:
- struct - file info
- string
path
- string
type
- string
last_modified_date
- string
checksum
- string
checksum_type
- int
size
- string
linkto
25.8. listProvidingChannels
- 名前
- listProvidingChannels
- 説明
- パッケージを提供するチャンネルを一覧表示します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- array:
- struct - channel
- string
label
- string
parent_label
- string
name
25.9. listProvidingErrata
- 名前
- listProvidingErrata
- 説明
- パッケージを提供するエラータを一覧表示します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- array:
- struct - errata
- string
advisory
- string
issue_date
- string
last_modified_date
- string
update_date
- string
synopsis
- string
type
25.10. listSourcePackages
- 名前
- listSourcePackages
- 説明
- ユーザーの組織内のソースパッケージをすべて一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - source_package
- int
id
- string
name
25.11. removePackage
- 名前
- removePackage
- 説明
- Satellite からパッケージを削除します。
- パラメーター
- string sessionKey
- int packageId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
25.12. removeSourcePackage
- 名前
- removeSourcePackage
- 説明
- ソースパッケージを削除します。
- パラメーター
- string sessionKey
- int packageSourceId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第26章 packages.provider
概要
パッケージに関連付けられているパッケージプロバイダーについての情報を取得するメソッドです。
26.1. associateKey
- 名前
- associateKey
- 説明
- パッケージセキュリティーキーとパッケージプロバイダーを関連付けます。パッケージもしくはキーが存在しない場合は、作成されます。リクエストを実行しているユーザーは、Satellite 管理者である必要があります。
- パラメーター
- string sessionKey
- string providerName - プロバイダー名
- string key - 実際のキー
- string type - キーのタイプ。現在は、「gpg」のみがサポートされています。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
26.2. list
- 名前
- list
- 説明
- 全パッケージプロバイダーを一覧表示します。リクエストを実行しているユーザーは、Satellite 管理者である必要があります。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - package provider
- string
name
- array
keys
- struct - package security key
- string
key
- string
type
26.3. listKeys
- 名前
- listKeys
- 説明
- パッケージプロバイダーに関連付けられているセキュリティーキーすべてを一覧表示します。リクエストを実行しているユーザーは、Satellite 管理者である必要があります。
- パラメーター
- string sessionKey
- string providerName - プロバイダー名
- 戻り値
- array:
- struct - package security key
- string
key
- string
type
第27章 packages.search
概要
検索サーバー内のパッケージ検索機能とインターフェイスするメソッド
27.1. advanced
- 名前
- advanced
- 説明
- Lucene Query Parser 構文で書かれたクエリでパスされた lucene インデックスを検索するための高度なメソッド。Lucene Query Parser 構文は、lucene.apache.org で定義されています。パッケージで検索可能なフィールド: name, epoch, version, release, arch, description, summary。Lucene クエリの例: "name:kernel AND version:2.6.18 AND -description:devel"
- パラメーター
- string sessionKey
- string luceneQuery - Lucene QueryParser 構文で書かれたクエリ
- 戻り値
- array:
- struct - package overview
- int
id
- string
name
- string
summary
- string
description
- string
version
- string
release
- string
arch
- string
epoch
- string
provider
27.2. advancedWithActKey
- 名前
- advancedWithActKey
- 説明
- Lucene Query Parser 構文で書かれたクエリでパスされた lucene インデックスを検索するための高度なメソッドで、このメソッドは指定したアクティベーションキーに関連付けられているものに結果を限定します。Lucene Query Parser 構文は、lucene.apache.org で定義されています。パッケージで検索可能なフィールド: name, epoch, version, release, arch, description, summary。Lucene クエリの例: "name:kernel AND version:2.6.18 AND -description:devel"
- パラメーター
- string sessionKey
- string luceneQuery - Lucene QueryParser 構文で書かれたクエリ
- string actKey - パッケージで検索するアクティベーションキー
- 戻り値
- array:
- struct - package overview
- int
id
- string
name
- string
summary
- string
description
- string
version
- string
release
- string
arch
- string
epoch
- string
provider
27.3. advancedWithChannel
- 名前
- advancedWithChannel
- 説明
- Lucene Query Parser 構文で書かれたクエリでパスされた lucene インデックスを検索するための高度なメソッドで、このメソッドは channel ラベルでパスされたものに結果を限定します。Lucene Query Parser 構文は、lucene.apache.org で定義されています。パッケージで検索可能なフィールド: name, epoch, version, release, arch, description, summary。Lucene クエリの例: "name:kernel AND version:2.6.18 AND -description:devel"
- パラメーター
- string sessionKey
- string luceneQuery - Lucene QueryParser 構文で書かれたクエリ
- string channelLabel - チャンネルのラベル
- 戻り値
- array:
- struct - package overview
- int
id
- string
name
- string
summary
- string
description
- string
version
- string
release
- string
arch
- string
epoch
- string
provider
27.4. name
- 名前
- name
- 説明
- 指定した名前に一致する全パッケージを lucene パッケージインデックスで検索します。
- パラメーター
- string sessionKey
- string name - 検索するパッケージ名
- 戻り値
- array:
- struct - package overview
- int
id
- string
name
- string
summary
- string
description
- string
version
- string
release
- string
arch
- string
epoch
- string
provider
27.5. nameAndDescription
- 名前
- nameAndDescription
- 説明
- 名前または説明で指定したクエリに一致する全パッケージを lucene パッケージインデックスで検索します。
- パラメーター
- string sessionKey
- string query - パッケージ名または説明で一致するテキスト
- 戻り値
- array:
- struct - package overview
- int
id
- string
name
- string
summary
- string
description
- string
version
- string
release
- string
arch
- string
epoch
- string
provider
27.6. nameAndSummary
- 名前
- nameAndSummary
- 説明
- 名前または概要で指定したクエリに一致する全パッケージを lucene パッケージインデックスで検索します。
- パラメーター
- string sessionKey
- string query - パッケージ名または概要で一致するテキスト
- 戻り値
- array:
- struct - package overview
- int
id
- string
name
- string
summary
- string
description
- string
version
- string
release
- string
arch
- string
epoch
- string
provider
第28章 preferences.locale
概要
ユーザーのロケール情報にアクセス、修正するメソッドを提供します。
28.1. listLocales
- 名前
- listLocales
- 説明
- 分かっているロケールすべての一覧を返します。setLocale への入力として利用できます。
- パラメーター
- なし
- 戻り値
- array:
- string - Locale code.
28.2. listTimeZones
- 名前
- listTimeZones
- 説明
- 分かっているタイムゾーンすべての一覧を返します。setTimeZone への入力として利用できます。
- パラメーター
- なし
- 戻り値
- array:
- struct - timezone
- int
time_zone_id
- タイムゾーンの一意の識別子 - string
olson_name
- Olson データベースで特定された名前
28.3. setLocale
- 名前
- setLocale
- 説明
- ユーザーのロケールを設定します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- string locale - (listLocales から) 設定するロケール
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
28.4. setTimeZone
- 名前
- setTimeZone
- 説明
- ユーザーのタイムゾーンを設定します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- int tzid - タイムゾーン ID (listTimeZones から)
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第29章 proxy
概要
プロキシサーバーをアクティベート、アクティベート解除するメソッドを提供します。
29.1. activateProxy
- 名前
- activateProxy
- 説明
- 指定したクライアント証明書 (systemid file) で特定してプロキシをアクティベートします。
- パラメーター
- string systemid - systemid file
- string version - 登録するプロキシのバージョン
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
29.2. createMonitoringScout
- 名前
- createMonitoringScout
- 説明
- プロキシ用に Monitoring スカウトを作成します。利用可能バージョン: 10.7 以降
- パラメーター
- string systemid - systemid file
- 戻り値
- string
29.3. deactivateProxy
- 名前
- deactivateProxy
- 説明
- 指定したクライアント証明書 (systemid file) で特定してプロキシをアクティベート解除します。
- パラメーター
- string systemid - systemid file
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
29.4. isProxy
- 名前
- isProxy
- 説明
- 指定したクライアント証明書 (systemid file) で特定したシステムがプロキシかどうかをテストします。
- パラメーター
- string systemid - systemid file
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
29.5. listAvailableProxyChannels
- 名前
- listAvailableProxyChannels
- 説明
- 指定したクライアント証明書 (systemid file) で特定したシステムのプロキシチャンネルの利用可能なバージョンを一覧表示します。利用可能バージョン: 10.5 以降
- パラメーター
- string systemid - systemid file
- 戻り値
- array:
- string - version
第30章 satellite
概要
Satellite についての詳細を取得するメソッドを提供します。
30.1. getCertificateExpirationDate
- 名前
- getCertificateExpirationDate
- 説明
- アクティベートされている証明書の有効期間を取得します。
- パラメーター
- string sessionKey
- 戻り値
- dateTime.iso8601
30.2. isMonitoringEnabled
- 名前
- isMonitoringEnabled
- 説明
- satellite でモニタリングが有効になっているかどうかを示します。
- パラメーター
- string sessionKey
- 戻り値
- boolean モニタリングが有効になっている場合、True
30.3. isMonitoringEnabledBySystemId
- 名前
- isMonitoringEnabledBySystemId
- 説明
- satellite でモニタリングが有効になっているかどうかを示します。
- パラメーター
- string systemid - systemid file
- 戻り値
- boolean モニタリングが有効になっている場合、True
30.4. listEntitlements
- 名前
- listEntitlements
- 説明
- リクエストを実行している有効に関連付けられている組織のすべてのチャンネルとシステムエンタイトルメントを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- 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
30.5. listProxies
- 名前
- listProxies
- 説明
- ユーザーの組織内のプロキシを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
第31章 schedule
概要
スケールされたアクションについての情報を取得するメソッド
31.1. archiveActions
- 名前
- archiveActions
- 説明
- 指定した一覧内の全アクションをアーカイブ化します。
- パラメーター
- string sessionKey
- array:
- int - action id
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
31.2. cancelActions
- 名前
- cancelActions
- 説明
- 指定した一覧内の全アクションをキャンセルします。無効なアクションがある場合は指定されたアクションはどれもキャンセルされません。
- パラメーター
- string sessionKey
- array:
- int - action id
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
31.3. deleteActions
- 名前
- deleteActions
- 説明
- 指定した一覧内のアーカイブ化された全アクションを削除します。
- パラメーター
- string sessionKey
- array:
- int - action id
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
31.4. failSystemAction
- 名前
- failSystemAction
- 説明
- 指定したシステムで特定イベントを失敗させます。
- パラメーター
- string sessionKey
- int serverId
- int actionId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
31.5. failSystemAction
- 名前
- failSystemAction
- 説明
- 指定したシステムで特定イベントを失敗させます。
- パラメーター
- string sessionKey
- int serverId
- int actionId
- string message
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
31.6. listAllActions
- 名前
- listAllActions
- 説明
- 全アクションの一覧を返します。完了済み、進行中、失敗、アーカイブ化されたアクションが含まれます。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - action
- int
id
- アクション ID - string
name
- アクション名 - string
type
- アクションのタイプ - string
scheduler
- アクションをスケジュールしたユーザー (オプション) - dateTime.iso8601
earliest
- アクションが予定される日時で最も早いもの - int
completedSystems
- アクションを完了したシステム数 - int
failedSystems
- アクションを失敗したシステム数 - int
inProgressSystems
- 進行中のシステム数
31.7. listArchivedActions
- 名前
- listArchivedActions
- 説明
- アーカイブ化されたアクション一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - action
- int
id
- アクション ID - string
name
- アクション名 - string
type
- アクションのタイプ - string
scheduler
- アクションをスケジュールしたユーザー (オプション) - dateTime.iso8601
earliest
- アクションが予定される日時で最も早いもの - int
completedSystems
- アクションを完了したシステム数 - int
failedSystems
- アクションを失敗したシステム数 - int
inProgressSystems
- 進行中のシステム数
31.8. listCompletedActions
- 名前
- listCompletedActions
- 説明
- 正常に完了したアクション一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - action
- int
id
- アクション ID - string
name
- アクション名 - string
type
- アクションのタイプ - string
scheduler
- アクションをスケジュールしたユーザー (オプション) - dateTime.iso8601
earliest
- アクションが予定される日時で最も早いもの - int
completedSystems
- アクションを完了したシステム数 - int
failedSystems
- アクションを失敗したシステム数 - int
inProgressSystems
- 進行中のシステム数
31.9. listCompletedSystems
- 名前
- listCompletedSystems
- 説明
- 特定のアクションを完了したシステム一覧を返します。
- パラメーター
- string sessionKey
- string actionId
- 戻り値
- array:
- struct - system
- int
server_id
- string
server_name
- サーバー名 - string
base_channel
- サーバーが使用するベースチャンネル - dateTime.iso8601
timestamp
- アクションが完了した日時 - string
message
- アクション実行の詳細を含むオプションのメッセージ。たとえば、アクションが失敗した場合、失敗テキストが含まれます。
31.10. listFailedActions
- 名前
- listFailedActions
- 説明
- 失敗したアクション一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - action
- int
id
- アクション ID - string
name
- アクション名 - string
type
- アクションのタイプ - string
scheduler
- アクションをスケジュールしたユーザー (オプション) - dateTime.iso8601
earliest
- アクションが予定される日時で最も早いもの - int
completedSystems
- アクションを完了したシステム数 - int
failedSystems
- アクションを失敗したシステム数 - int
inProgressSystems
- 進行中のシステム数
31.11. listFailedSystems
- 名前
- listFailedSystems
- 説明
- 特定のアクションを失敗したシステム一覧を返します。
- パラメーター
- string sessionKey
- string actionId
- 戻り値
- array:
- struct - system
- int
server_id
- string
server_name
- サーバー名 - string
base_channel
- サーバーが使用するベースチャンネル - dateTime.iso8601
timestamp
- アクションが完了した日時 - string
message
- アクション実行の詳細を含むオプションのメッセージ。たとえば、アクションが失敗した場合、失敗テキストが含まれます。
31.12. listInProgressActions
- 名前
- listInProgressActions
- 説明
- 進行中のアクション一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - action
- int
id
- アクション ID - string
name
- アクション名 - string
type
- アクションのタイプ - string
scheduler
- アクションをスケジュールしたユーザー (オプション) - dateTime.iso8601
earliest
- アクションが予定される日時で最も早いもの - int
completedSystems
- アクションを完了したシステム数 - int
failedSystems
- アクションを失敗したシステム数 - int
inProgressSystems
- 進行中のシステム数
31.13. listInProgressSystems
- 名前
- listInProgressSystems
- 説明
- 特定のアクションが進行中のシステム一覧を返します。
- パラメーター
- string sessionKey
- string actionId
- 戻り値
- array:
- struct - system
- int
server_id
- string
server_name
- サーバー名 - string
base_channel
- サーバーが使用するベースチャンネル - dateTime.iso8601
timestamp
- アクションが完了した日時 - string
message
- アクション実行の詳細を含むオプションのメッセージ。たとえば、アクションが失敗した場合、失敗テキストが含まれます。
31.14. rescheduleActions
- 名前
- rescheduleActions
- 説明
- 指定した一覧内の全アクションをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - action id
- boolean onlyFailed - 失敗したアクションのみを再スケジュールする場合は True、すべてを再スケジュールする場合は False
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第32章 sync.master
概要
ISS のスレーブ側で使用する、既知のマスターについての情報を設定するメソッド
32.1. addToMaster
- 名前
- addToMaster
- 説明
- 指定したマスターがスレーブにエクスポートした一覧に単一組織を追加します。
- パラメーター
- string sessionKey
- int id - 希望するマスターの ID
- struct - master-org details
- int
masterOrgId
- string
masterOrgName
- int
localOrgId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.2. create
- 名前
- create
- 説明
- スレーブが認識している新規マスターを作成します。
- パラメーター
- string sessionKey
- string label - マスターの完全修飾ドメイン名
- 戻り値
- struct - IssMaster info
- int
id
- string
label
- string
caCert
- boolean
isCurrentMaster
32.3. delete
- 名前
- delete
- 説明
- 指定したマスターを削除します。
- パラメーター
- string sessionKey
- int id - 削除するマスターの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.4. getDefaultMaster
- 名前
- getDefaultMaster
- 説明
- スレーブにおける現行のデフォルトマスターを返します。
- パラメーター
- string sessionKey
- 戻り値
- struct - IssMaster info
- int
id
- string
label
- string
caCert
- boolean
isCurrentMaster
32.5. getMaster
- 名前
- getMaster
- 説明
- ID で指定してマスターを探します。
- パラメーター
- string sessionKey
- int id - 希望するマスターの ID
- 戻り値
- struct - IssMaster info
- int
id
- string
label
- string
caCert
- boolean
isCurrentMaster
32.6. getMasterByLabel
- 名前
- getMasterByLabel
- 説明
- ラベルで指定してマスターを探します。
- パラメーター
- string sessionKey
- string label - 希望するマスターのラベル
- 戻り値
- struct - IssMaster info
- int
id
- string
label
- string
caCert
- boolean
isCurrentMaster
32.7. getMasterOrgs
- 名前
- getMasterOrgs
- 説明
- 指定したマスターがスレーブをエクスポートした全組織を一覧表示します。
- パラメーター
- string sessionKey
- int id - 希望するマスターの ID
- 戻り値
- array:
- struct - IssMasterOrg info
- int
masterOrgId
- string
masterOrgName
- int
localOrgId
32.8. getMasters
- 名前
- getMasters
- 説明
- スレーブが認識している全マスターを取得します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - IssMaster info
- int
id
- string
label
- string
caCert
- boolean
isCurrentMaster
32.9. makeDefault
- 名前
- makeDefault
- 説明
- 指定したマスターをスレーブの satellite 同期用にデフォルトにします。
- パラメーター
- string sessionKey
- int id - デフォルトにするマスターの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.10. mapToLocal
- 名前
- mapToLocal
- 説明
- 指定したマスターがスレーブにエクスポートした一覧に単一組織を追加します。
- パラメーター
- string sessionKey
- int masterId - 希望するマスターの ID
- int masterOrgId - 希望するマスターの ID
- int localOrgId - 希望するマスターの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.11. setCaCert
- 名前
- setCaCert
- 説明
- スレーブ上で指定したマスターに CA-CERT ファイル名を設定します。
- パラメーター
- string sessionKey
- int id - 影響を受けるマスターの ID
- string caCertFilename - 指定したマスターの CA 証明書
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.12. setMasterOrgs
- 名前
- setMasterOrgs
- 説明
- 指定したマスターがスレーブをエクスポートした全組織を再設定します。
- パラメーター
- string sessionKey
- int id - 希望するマスターの ID
- array:
- struct - master-org details
- int
masterOrgId
- string
masterOrgName
- int
localOrgId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.13. unsetDefaultMaster
- 名前
- unsetDefaultMaster
- 説明
- スレーブに satellite 同期用のデフォルトマスターをなくします。
- パラメーター
- string sessionKey
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
32.14. update
- 名前
- update
- 説明
- 指定したマスターのラベルを更新します。
- パラメーター
- string sessionKey
- int id - 更新するマスターの ID
- string label - 希望する新ラベル
- 戻り値
- struct - IssMaster info
- int
id
- string
label
- string
caCert
- boolean
isCurrentMaster
第33章 sync.slave
概要
ISS のマスター側で使用する、許可済みスレーブについての情報を設定するメソッドが含まれます。
33.1. create
- 名前
- create
- 説明
- マスターが認識している新規スレーブを作成します。
- パラメーター
- string sessionKey
- string slave - スレーブの完全修飾ドメイン名
- boolean enabled - このスレーブからの通信を許可するかどうか
- boolean allowAllOrgs - このスレーブに全組織をエクスポートするかどうか
- 戻り値
- struct - IssSlave info
- int
id
- string
slave
- boolean
enabled
- boolean
allowAllOrgs
33.2. delete
- 名前
- delete
- 説明
- 指定したスレーブを削除します。
- パラメーター
- string sessionKey
- int id - 削除するスレーブの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
33.3. getAllowedOrgs
- 名前
- getAllowedOrgs
- 説明
- このマスターが指定したスレーブにエクスポートする全組織を取得します。
- パラメーター
- string sessionKey
- int id - 希望するスレーブの ID
- 戻り値
- array:
- int - 許可された組織の ID
33.4. getSlave
- 名前
- getSlave
- 説明
- ID で指定してスレーブを探します。
- パラメーター
- string sessionKey
- int id - 希望するスレーブの ID
- 戻り値
- struct - IssSlave info
- int
id
- string
slave
- boolean
enabled
- boolean
allowAllOrgs
33.5. getSlaveByName
- 名前
- getSlaveByName
- 説明
- スレーブの完全修飾ドメイン名を指定してスレーブを探します。
- パラメーター
- string sessionKey
- string fqdn - 希望するスレーブのドメイン名
- 戻り値
- struct - IssSlave info
- int
id
- string
slave
- boolean
enabled
- boolean
allowAllOrgs
33.6. getSlaves
- 名前
- getSlaves
- 説明
- マスターが認識している全スレーブを取得します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - IssSlave info
- int
id
- string
slave
- boolean
enabled
- boolean
allowAllOrgs
33.7. setAllowedOrgs
- 名前
- setAllowedOrgs
- 説明
- このマスターが指定したスレーブにエクスポートする全組織を設定します。
- パラメーター
- string sessionKey
- int id - 希望するスレーブの ID
- array:
- int - エクスポートする組織 ID 一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
33.8. update
- 名前
- update
- 説明
- 指定したスレーブの属性を更新します。
- パラメーター
- string sessionKey
- int id - 更新するスレーブの ID
- string slave - スレーブの完全修飾ドメイン名
- boolean enabled - このスレーブからの通信を許可するかどうか
- boolean allowAllOrgs - このスレーブに全組織をエクスポートするかどうか
- 戻り値
- struct - IssSlave info
- int
id
- string
slave
- boolean
enabled
- boolean
allowAllOrgs
第34章 system
概要
登録済みシステムにアクセス、修正するメソッドを提供します。
34.1. addEntitlements
- 名前
- addEntitlements
- 説明
- サーバーにエンタイトルメントを追加します。サーバーに既存のエンタイトルメントは無視されます。
- パラメーター
- string sessionKey
- int serverId
- array:
- string - entitlementLabel - 以下のうちのいずれか: provisioning_entitled、virtualization_host、virtualization_host_platform、enterprise_entitled
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.2. addNote
- 名前
- addNote
- 説明
- 新規 note を指定したサーバーに追加します。
- パラメーター
- string sessionKey
- int serverId
- string subject - note の主題
- string body - note のコンテンツ
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.3. applyErrata
- 名前
- applyErrata
- 説明
- エラータ更新をシステムに適用するアクションをスケジュールします。廃止予定 - system.scheduleApplyErrata(string sessionKey、int serverId、array[int errataId]) に置換されます。
- パラメーター
- string sessionKey
- int serverId
- array:
- int - errataId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.4. comparePackageProfile
- 名前
- comparePackageProfile
- 説明
- システムのパッケージをパッケージプロファイルと比較します。返される結果では、'this_system' は入力として提供されたサーバーを、'other_system' は入力として提供されたプロファイルを表します。
- パラメーター
- string sessionKey
- int serverId
- string profileLabel
- 戻り値
- 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
- このシステムのパッケージのバージョン - string
other_system
- 他のシステムのパッケージのバージョン - int
comparison
- 0 - 差異なし
- 1 - このシステムのパッケージのみ
- 2 - このシステムの新しいパッケージのバージョン
- 3 - 他のシステムのパッケージのみ
- 4 - 他のシステムの新しいパッケージのバージョン
34.5. comparePackages
- 名前
- comparePackages
- 説明
- 2 つのシステムにインストールされているパッケージを比較します。
- パラメーター
- string sessionKey
- int thisServerId
- int otherServerId
- 戻り値
- 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
- このシステムのパッケージのバージョン - string
other_system
- 他のシステムのパッケージのバージョン - int
comparison
- 0 - 差異なし
- 1 - このシステムのパッケージのみ
- 2 - このシステムの新しいパッケージのバージョン
- 3 - 他のシステムのパッケージのみ
- 4 - 他のシステムの新しいパッケージのバージョン
34.6. convertToFlexEntitlement
- 名前
- convertToFlexEntitlement
- 説明
- 指定されたチャンネルファミリーのシステム一覧を flex エンタイトルメントを使用するために変換します。
- パラメーター
- string sessionKey
- array:
- int - serverId
- string channelFamilyLabel
- 戻り値
- int - flex エンタイトルメント使用のために変換されたシステムの合計数。
34.7. createPackageProfile
- 名前
- createPackageProfile
- 説明
- システムにインストールされたパッケージ一覧から、新規の保存パッケージプロファイルを作成します。
- パラメーター
- string sessionKey
- int serverId
- string profileLabel
- string description
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.8. createSystemRecord
- 名前
- createSystemRecord
- 説明
- cobbler システムレコードを指定したキックスタートラベルで作成します。
- パラメーター
- string sessionKey
- int serverId
- string ksLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.9. deleteCustomValues
- 名前
- deleteCustomValues
- 説明
- 指定されたシステムから、提供されたカスタムシステム情報キーに定義されたカスタム値を削除します。
- パラメーター
- string sessionKey
- int serverId
- array:
- string - customInfoLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
注記
存在しないキーの値を削除しようとすると、例外がスローされます。値には割り当てられていない既存のキーの値を削除しようとすると、例外はスローされません。
34.10. deleteGuestProfiles
- 名前
- deleteGuestProfiles
- 説明
- 特定ホストの指定されたゲストプロファイル一覧を削除します。
- パラメーター
- string sessionKey
- int hostId
- array:
- string - guestNames
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.11. deleteNote
- 名前
- deleteNote
- 説明
- サーバーから指定された note を削除します。
- パラメーター
- string sessionKey
- int serverId
- int noteId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.12. deleteNotes
- 名前
- deleteNotes
- 説明
- サーバーからすべての note を削除します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.13. deletePackageProfile
- 名前
- deletePackageProfile
- 説明
- パッケージプロファイルを削除します。
- パラメーター
- string sessionKey
- int profileId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.14. deleteSystem
- 名前
- deleteSystem
- 説明
- クライアント証明書を指定してシステムを削除します。利用可能バージョン: 10.10 以降
- パラメーター
- string systemid - systemid file
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.15. deleteSystem
- 名前
- deleteSystem
- 説明
- サーバー ID を指定して同期的にシステムを削除します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.16. deleteSystems
- 名前
- deleteSystems
- 説明
- システム ID を指定して、非同期でシステムを削除します。
- パラメーター
- string sessionKey
- array:
- int - serverId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.17. deleteTagFromSnapshot
- 名前
- deleteTagFromSnapshot
- 説明
- システムスナップショットからタグを削除します。
- パラメーター
- string sessionKey
- int serverId
- string tagName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.18. downloadSystemId
- 名前
- downloadSystemId
- 説明
- 指定したサーバーのシステム ID ファイルを取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- string
34.19. getConnectionPath
- 名前
- getConnectionPath
- 説明
- サーバーに接続するために指定されたシステムが接続するプロキシ一覧を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - proxy connection path details
- int
position
- チェーンでのプロキシの位置。システムが直接接続するプロキシは、最初に表示されます。 - int
id
- プロキシのシステム ID - string
hostname
- プロキシのホスト名
34.20. getCpu
- 名前
- getCpu
- 説明
- システムの CPU 情報を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - CPU
- string
cache
- string
family
- string
mhz
- string
flags
- string
model
- string
vendor
- string
arch
- string
stepping
- string
count
- int
socket_count (ある場合)
34.21. getCustomValues
- 名前
- getCustomValues
- 説明
- サーバーに定義されたカスタムデータ値を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - custom value
- string
custom info label
34.22. getDetails
- 名前
- getDetails
- 説明
- システムの詳細を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - server details
- int
id
- システム ID - string
profile_name
- string
base_entitlement
- システムのベースエンタイトルメントラベル (enterprise_entitled または sw_mgr_entitled) - array
string
- addon_entitlements - システムのアドオンエンタイトルメントラベル。以下を含みます: provisioning_entitled、virtualization_host、virtualization_host_platform
- boolean
auto_update
- システムので自動エラータ更新が有効になっている場合は、true - string
release
- オペレーティングシステムのリリース (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
- 'unknown'、'offline'、'online' のいずれか。 - boolean
lock_status
- システムがロックされている場合は True。システムがロックされていない場合は False。 - string
virtualization
- 仮想化のタイプ。仮想ゲストのみ (オプション)
34.23. getDevices
- 名前
- getDevices
- 説明
- システムのデバイス一覧を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - device
- string
device
- オプション - string
device_class
- CDROM、FIREWIRE、HD、USB、VIDEO、OTHER などを含みます。 - string
driver
- string
description
- string
bus
- string
pcitype
34.24. getDmi
- 名前
- getDmi
- 説明
- システムの DMI 情報を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - DMI
- string
vendor
- string
system
- string
product
- string
asset
- string
board
- string
bios_release
- (オプション) - string
bios_vendor
- (オプション) - string
bios_version
- (オプション)
34.25. getEntitlements
- 名前
- getEntitlements
- 説明
- 指定したサーバーのエンタイトルメントを取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- string - entitlement_label
34.26. getEventHistory
- 名前
- getEventHistory
- 説明
- システムに関連付けられている履歴アイテムの一覧を、最新のものからの順序で返します。(インスタントではなく) システムに対してスケジュールされているイベントの場合、詳細が空であることがあります。このようなイベントについての詳細情報は、system.listSystemEvents を参照してください。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - History Event
- dateTime.iso8601
completed
- イベントの発生日時 (オプション) - string
summary
- イベントの概要 - string
details
- イベントの詳細
34.27. getId
- 名前
- getId
- 説明
- システム ID と指定したシステム名の最新チェックイン情報を取得します。
- パラメーター
- string sessionKey
- string systemName
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.28. getMemory
- 名前
- getMemory
- 説明
- システムのメモリー情報を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - memory
- int
ram
- 物理的メモリーサイズ (MB) - int
swap
- スワップ領域 (MB)
34.29. getName
- 名前
- getName
- 説明
- システム名と指定したシステム ID の最新チェックイン情報を取得します。
- パラメーター
- string sessionKey
- string serverId
- 戻り値
- struct - name info
- int
id
- サーバー ID - string
name
- サーバー名 - dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時
34.30. getNetwork
- 名前
- getNetwork
- 説明
- 指定したサーバーのアドレスとホスト名を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - network info
- string
ip
- サーバーの IPv4 アドレス - string
ip6
- サーバーの IPv6 - string
hostname
- サーバーのホスト名
34.31. getNetworkDevices
- 名前
- getNetworkDevices
- 説明
- 指定したサーバーのネットワークデバイスを返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - network device
- string
ip
- このネットワークデバイスに割り当てられている IP アドレス - string
interface
- デバイスに割り当てられているネットワークインターフェイス。例: eth0 - string
netmask
- デバイスに割り当てられているネットワークマスク - string
hardware_address
- デバイスのハードウェアアドレス - string
module
- このデバイスに使用しているネットワークドライバー - string
broadcast
- デバイスのブロードキャストアドレス - array
ipv6
- IPv6 アドレス一覧 - array:
- struct - ipv6 address
- string
address
- このネットワークデバイスの IPv6 アドレス - string
netmask
- このネットワークデバイスの IPv6 ネットマスク - string
scope
- IPv6 アドレススコープ
34.32. getOsaPing
- 名前
- getOsaPing
- 説明
- OSA を使用しているシステムに送信される ping の詳細を取得します。
- パラメーター
- User loggedInUser
- int serverId
- 戻り値
- struct - osaPing
- String
state
- システムの状態 (unknown、online、offline) - dateTime.iso8601
lastMessageTime
- 最終応答の日時 (応答がなかった場合は、1970/01/01 00:00:00) - dateTime.iso8601
lastPingTime
- ping の最終送信日時 (保留中の ping がない場合は、1970/01/01 00:00:00)
34.33. getRegistrationDate
- 名前
- getRegistrationDate
- 説明
- システムの登録日時を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- dateTime.iso8601 - ローカルタイムでシステムが登録された日時
34.34. getRelevantErrata
- 名前
- getRelevantErrata
- 説明
- システムに関連するエラータ一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
update_date
- エラータの更新日 - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前
34.35. getRelevantErrataByType
- 名前
- getRelevantErrataByType
- 説明
- システムに関連する指定したタイプのエラータ一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- string advisoryType - アドバイザリーのタイプ ('Security Advisory'、'Product Enhancement Advisory'、'Bug Fix Advisory' のいずれか)
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
update_date
- エラータの更新日 - string
advisory_synopsis
- エラータの概要 - string
advisory_type
- セキュリティーやバグ修正などのタイプのラベル - string
advisory_name
- RHSA などの名前
34.36. getRunningKernel
- 名前
- getRunningKernel
- 説明
- 指定したシステムの実行中のカーネルを返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- string
34.37. getScriptActionDetails
- 名前
- getScriptActionDetails
- 説明
- スクリプトで実行するアクションのスクリプト詳細を返します。
- パラメーター
- string sessionKey
- int actionId - スクリプト実行アクションの ID
- 戻り値
- struct - スクリプトの詳細
- int
id
- アクション ID - string
content
- スクリプトのコンテンツ - string
run_as_user
- ユーザーとして実行 - string
run_as_group
- グループとして実行 - int
timeout
- タイムアウト (秒単位) - array:
- struct - script result
- int
serverId
- スクリプトを実行するサーバー ID - dateTime.iso8601
startDate
- スクリプトの開始時間 - dateTime.iso8601
stopDate
- スクリプトの終了時間 - int
returnCode
- スクリプト実行のリターンコード - string
output
- スクリプト出力 (output_enc64 属性に従って base64 エンコード化) - boolean
output_enc64
- base64 エンコード化された出力を特定
34.38. getScriptResults
- 名前
- getScriptResults
- 説明
- スクリプト実行から結果をフェッチします。利用可能な結果がない場合は、空のアレイを返します。
- パラメーター
- string sessionKey
- int actionId - スクリプト実行アクションの ID
- 戻り値
- array:
- struct - script result
- int
serverId
- スクリプトを実行するサーバー ID - dateTime.iso8601
startDate
- スクリプトの開始時間 - dateTime.iso8601
stopDate
- スクリプトの終了時間 - int
returnCode
- スクリプト実行のリターンコード - string
output
- スクリプト出力 (output_enc64 属性に従って base64 エンコード化) - boolean
output_enc64
- base64 エンコード化された出力を特定
34.39. getSubscribedBaseChannel
- 名前
- getSubscribedBaseChannel
- 説明
- 指定したシステムのベースチャンネルを提供します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
34.40. getSystemCurrencyMultipliers
- 名前
- getSystemCurrencyMultipliers
- 説明
- システム通貨スコアマルチプライヤーを取得します。
- パラメーター
- string sessionKey
- 戻り値
- スコアマルチプライヤーのマップ
34.41. getSystemCurrencyScores
- 名前
- getSystemCurrencyScores
- 説明
- ユーザーがアクセスできる全サーバーのシステム通貨スコアを取得します。
- パラメーター
- string sessionKey
- 戻り値
- 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
34.42. getUnscheduledErrata
- 名前
- getUnscheduledErrata
- 説明
- 指定したシステムに適用可能なエラータのアレイを提供します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - errata
- int
id
- エラータ ID - string
date
- エラータの作成日 - string
advisory_type
- アドバイザリーのタイプ - string
advisory_name
- アドバイザリー名 - string
advisory_synopsis
- エラータの概要
34.43. getUuid
- 名前
- getUuid
- 説明
- 指定したシステム ID から UUID を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- string
34.44. getVariables
- 名前
- getVariables
- 説明
- 指定したサーバーのシステムレコードに設定されているキックスタート変数を一覧表示します。この呼び出しは、指定したシステムの cobbler にシステムレコードが存在することを前提としており、存在しない場合は XMLRPC エラーが発生します。XMLRPC でシステムレコードを作成する場合は、system.createSystemRecord を使用します。Web UI でシステムレコードを作成するには、System -> <Specified System> -> Provisioning -> Select a Kickstart profile -> Create Cobbler System Record に移動します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - System kickstart variables
- boolean
netboot
- netboot 有効 - array
kickstart variables
- struct - kickstart variable
- string
key
- string or int
value
34.45. isNvreInstalled
- 名前
- isNvreInstalled
- 説明
- 指定した NVRE のパッケージがシステムにインストールされているかどうかを確認します。
- パラメーター
- string sessionKey
- int serverId
- string name - パッケージ名
- string version - パッケージのバージョン
- string release - パッケージのリリース
- 戻り値
- パッケージが存在する場合は 1、それ以外は 0。エラーが発生すると例外がスローされます。
34.46. isNvreInstalled
- 名前
- isNvreInstalled
- 説明
- 指定した NVRE のパッケージがシステムにインストールされているかどうかを確認します。
- パラメーター
- string sessionKey
- int serverId
- string name - パッケージ名
- string version - パッケージのバージョン
- string release - パッケージのリリース
- string epoch - パッケージのエポック
- 戻り値
- パッケージが存在する場合は 1、それ以外は 0。エラーが発生すると例外がスローされます。
34.47. listActivationKeys
- 名前
- listActivationKeys
- 説明
- システムが登録されているアクティベーションキーを一覧表示します。登録時にアクティベーションキーが使用されていない場合は、空の一覧が返されます。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- string - キー
34.48. listActiveSystems
- 名前
- listActiveSystems
- 説明
- ユーザーに見えるアクティブなサーバー一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.49. listActiveSystemsDetails
- 名前
- listActiveSystemsDetails
- 説明
- サーバー ID の一覧を与えると、ユーザーに見えるアクティブなサーバーの詳細一覧が返されます。
- パラメーター
- string sessionKey
- array:
- int - serverIds
- 戻り値
- array:
- struct - server details
- int
id
- サーバーの ID - string
name
- サーバー名 - dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 (UTC) - int
ram
- 物理的メモリーサイズ (MB) - int
swap
- スワップ領域 (MB) - struct
network_devices
- サーバーのネットワークデバイス - struct - network device
- string
ip
- このネットワークデバイスに割り当てられている IP アドレス - string
interface
- デバイスに割り当てられているネットワークインターフェイス。例: eth0 - string
netmask
- デバイスに割り当てられているネットワークマスク - string
hardware_address
- デバイスのハードウェアアドレス - string
module
- このデバイスに使用しているネットワークドライバー - string
broadcast
- デバイスのブロードキャストアドレス - array
ipv6
- IPv6 アドレス一覧 - array:
- struct - ipv6 address
- string
address
- このネットワークデバイスの IPv6 アドレス - string
netmask
- このネットワークデバイスの IPv6 ネットマスク - string
scope
- IPv6 アドレススコープ
- struct
dmi_info
- サーバーの dmi 情報 - struct - DMI
- string
vendor
- string
system
- string
product
- string
asset
- string
board
- string
bios_release
- (オプション) - string
bios_vendor
- (オプション) - string
bios_version
- (オプション)
- struct
cpu_info
- サーバーの cpu 情報 - struct - CPU
- string
cache
- string
family
- string
mhz
- string
flags
- string
model
- string
vendor
- string
arch
- string
stepping
- string
count
- int
socket_count (ある場合)
- array
subscribed_channels
- サブスクライブしているチャンネル一覧 - array:
- struct - channel
- int
channel_id
- チャンネル ID - string
channel_label
- チャンネルのラベル
- array
active_guest_system_ids
- アクティブなゲストの仮想ゲストシステム ID 一覧 - array:
- int
guest_id
- ゲストのシステム ID
34.50. listAdministrators
- 名前
- listAdministrators
- 説明
- システムを管理できるユーザー一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - user
- int
id
- string
login
- string
login_uc
- ログインの大文字バージョン - boolean
enabled
- ユーザーが有効な場合は true、無効な場合は false
34.51. listAllInstallablePackages
- 名前
- listAllInstallablePackages
- 説明
- 指定したシステムでインストール可能な全パッケージ一覧を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
34.52. listBaseChannels
- 名前
- listBaseChannels
- 説明
- サブスクライブ可能なベースチャンネル一覧を返します。廃止予定 - listSubscribableBaseChannels(string sessionKey、int serverId) に置換されます。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - channel
- int
id
- ベースチャンネルの ID - string
name
- チャンネル名 - string
label
- ラベル名 - int
current_base
- 1 の場合、現行のベースチャンネルであることを示します。
34.53. listChildChannels
- 名前
- listChildChannels
- 説明
- サブスクライブ可能な子チャンネル一覧を返します。システムがサブスクライブしていないチャンネルのみを表示します。廃止予定 - listSubscribableChildChannels(string sessionKey、int serverId) に置換されます。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - child channel
- int
id
- string
name
- string
label
- string
summary
- string
has_license
- string
gpg_key_url
34.54. listDuplicatesByHostname
- 名前
- listDuplicatesByHostname
- 説明
- ホスト名ごとに重複するシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - Duplicate Group
- string
hostname
- array
systems
- struct - system
- int
systemId
- string
systemName
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時
34.55. listDuplicatesByIp
- 名前
- listDuplicatesByIp
- 説明
- IP アドレスごとに重複するシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - Duplicate Group
- string
ip
- array
systems
- struct - system
- int
systemId
- string
systemName
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時
34.56. listDuplicatesByMac
- 名前
- listDuplicatesByMac
- 説明
- Mac アドレスごとに重複するシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - Duplicate Group
- string
mac
- array
systems
- struct - system
- int
systemId
- string
systemName
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時
34.57. listEligibleFlexGuests
- 名前
- listEligibleFlexGuests
- 説明
- ユーザーがアクセス可能な有資格の Flex ゲストを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel family system group
- int
id
- string
label
- string
name
- array:
- int - systems
34.58. listExtraPackages
- 名前
- listExtraPackages
- 説明
- システムの追加パッケージを一覧表示します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- ゼロ以外の場合にのみ、返します。 - string
arch
- date
installtime
- 判明する場合にのみ、返します。
34.59. listFlexGuests
- 名前
- listFlexGuests
- 説明
- ユーザーがアクセス可能な Flex ゲストを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - channel family system group
- int
id
- string
label
- string
name
- array:
- int - systems
34.60. listGroups
- 名前
- listGroups
- 説明
- 指定したシステムで利用可能なグループを一覧表示します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - system group
- int
id
- サーバーグループ ID - int
subscribed
- 指定したサーバーがこのサーバーグループをサブスクライブしている場合は 1、それ以外は 0 - string
system_group_name
- サーバーグループ名 - string
sgid
- サーバーグループの ID (廃止予定)
34.61. listInactiveSystems
- 名前
- listInactiveSystems
- 説明
- デフォルトの非アクティブ期間の間、非アクティブになっているシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.62. listInactiveSystems
- 名前
- listInactiveSystems
- 説明
- 指定した日数の間、非アクティブになっているシステムを一覧表示します。
- パラメーター
- string sessionKey
- int days
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.63. listLatestAvailablePackage
- 名前
- listLatestAvailablePackage
- 説明
- 各システムで利用可能なパッケージの最新バージョンを取得します。
- パラメーター
- string sessionKey
- array:
- int - serverId
- string packageName
- 戻り値
- array:
- struct - system
- int
id
- サーバー ID - string
name
- サーバー名 - struct
package
- package structure - struct - package
- int
id
- string
name
- string
version
- string
release
- string
epoch
- string
arch
34.64. listLatestInstallablePackages
- 名前
- listLatestInstallablePackages
- 説明
- 指定したシステムでインストール可能な最新パッケージ一覧を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
34.65. listLatestUpgradablePackages
- 名前
- listLatestUpgradablePackages
- 説明
- 指定したシステムでアップグレード可能な最新パッケージ一覧を取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- 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
34.66. listNewerInstalledPackages
- 名前
- listNewerInstalledPackages
- 説明
- パッケージ名、バージョン、リリース、およびエポックを指定すると、システムにインストールされているより新しいパッケージ名一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- string name - パッケージ名
- string version - パッケージのバージョン
- string release - パッケージのリリース
- string epoch - パッケージのエポック
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
34.67. listNotes
- 名前
- listNotes
- 説明
- システムに関連付けられている note 一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - note details
- int
id
- string
subject
- note の件名 - string
note
- note のコンテンツ - int
system_id
- note に関連付けられているシステムの ID - string
creator
- 存在する場合、note の作成者 (オプション) - date
updated
- note の最新更新日
34.68. listOlderInstalledPackages
- 名前
- listOlderInstalledPackages
- 説明
- パッケージ名、バージョン、リリース、およびエポックを指定すると、システムにインストールされているより古いパッケージ名一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- string name - パッケージ名
- string version - パッケージのバージョン
- string release - パッケージのリリース
- string epoch - パッケージのエポック
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
34.69. listOutOfDateSystems
- 名前
- listOutOfDateSystems
- 説明
- パッケージ更新が必要なシステム一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.70. listPackageProfiles
- 名前
- listPackageProfiles
- 説明
- 組織のパッケージプロファイルを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - package profile
- int
id
- string
name
- string
channel
34.71. listPackages
- 名前
- listPackages
- 説明
- 指定したシステムにインストール済みのパッケージを一覧表示します。installtime 属性は、API バージョン 10.10 から返されます。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- string
arch
- date
installtime
- 判明する場合にのみ、返します。
34.72. listPackagesFromChannel
- 名前
- listPackagesFromChannel
- 説明
- システムにインストール済みのパッケージで、指定したチャンネルにも含まれているものの一覧を返します。RHEL 5 より前では、インストール済みパッケージ一覧にはアーキテクチャー情報は含まれておらず、アーキテクチャーは認識していませんでした。RHEL 5 システムではアーキテクチャー情報をアップロードするので、アーキテクチャーを認識します。
- パラメーター
- string sessionKey
- int serverId
- string channelLabel
- 戻り値
- array:
- struct - package
- string
name
- string
version
- string
release
- string
epoch
- int
id
- string
arch_label
- string
path
- パッケージが格納されているファイルシステムのパス - string
provider
- パッケージのプロバイダー。署名した gpg キーで判定。 - dateTime.iso8601
last_modified
34.73. listPhysicalSystems
- 名前
- listPhysicalSystems
- 説明
- ユーザーに見えるすべての物理サーバー一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.74. listSubscribableBaseChannels
- 名前
- listSubscribableBaseChannels
- 説明
- サブスクライブ可能なベースチャンネル一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - channel
- int
id
- ベースチャンネルの ID - string
name
- チャンネル名 - string
label
- ラベル名 - int
current_base
- 1 の場合、現行のベースチャンネルであることを示します。
34.75. listSubscribableChildChannels
- 名前
- listSubscribableChildChannels
- 説明
- サブスクライブ可能な子チャンネル一覧を返します。システムがサブスクライブしていないチャンネルのみを表示します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - child channel
- int
id
- string
name
- string
label
- string
summary
- string
has_license
- string
gpg_key_url
34.76. listSubscribedChildChannels
- 名前
- listSubscribedChildChannels
- 説明
- サブスクライブしている子チャンネル一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- 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
- (オプション) - string
end_of_life
- string
parent_channel_label
- string
clone_original
- array:
- struct - contentSources
- int
id
- string
label
- string
sourceUrl
- string
type
34.77. listSuggestedReboot
- 名前
- listSuggestedReboot
- 説明
- 再起動が必要なシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
34.78. listSystemEvents
- 名前
- listSystemEvents
- 説明
- 指定したサーバーの特定タイプのシステムイベントを一覧表示します。"actionType" は、listSystemEvents(sessionKey, serverId) メソッドで返される action_type フィールドの文字列と同じものである必要があります。たとえば、「Package Install」や「Initiate a kickstart for a virtual guest」のようになります。利用可能バージョン: 10.8 以降
- パラメーター
- string sessionKey
- int serverId - システム ID
- string actionType - アクションのタイプ
- 戻り値
- array:
- struct - action
- int
failed_count
- アクションの失敗回数 - string
modified
- 修正日時 (modified_date に置換される予定) - dateTime.iso8601
modified_date
- 修正日時 - string
created
- 作成日時 (created_date に置換される予定) - dateTime.iso8601
created_date
- 作成日時 - string
action_type
- int
successful_count
- アクションの成功回数 - string
earliest_action
- アクションが予定される日時で最も早いもの - int
archived
- アクションが達成されたかどうか (1 または 0) - string
scheduler_user
- 具体的なユーザーがこのアクションをスケジュールした場合にのみ、利用可能 - string
prerequisite
- 前提条件のアクション (オプション) - string
name
- アクション名 - int
id
- アクション ID - string
version
- アクションのバージョン - string
completion_time
- イベントの完了日時。 フォーマットは ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0。 (オプション) (completed_date で置換される予定) - dateTime.iso8601
completed_date
- イベントの完了日時 (オプション) - string
pickup_time
- アクションのピックアップ日時。 フォーマットは ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0。 (オプション) (pickup_date で置換される予定) - dateTime.iso8601
pickup_date
- アクションのピックアップ日時 (オプション) - string
result_msg
- クライアントマシンでアクションが実行された後の結果文字列 (オプション) - array
additional_info
- このアレイには、利用可能な場合にイベントの追加情報が含まれます。- struct - info
- string
detail
- 提供される詳細は、特定のイベントに依存します。たとえば、パッケージイベントの場合はパッケージ名となり、エラーイベントの場合はアドバイザリー名および概要となり、設定ファイルイベントの場合はパスおよびオプションで改訂履歴となります。 - string
result
- 結果 (含まれる場合) は特定のイベントに依存します。たとえば、パッケージもしくはエラータイベントの場合は結果は含まれません。設定ファイルイベントの場合は結果にエラーが含まれたり (ファイルが見つからないなど、エラーが発生した場合)、設定ファイルの比較の場合は見つかった差異が含まれることがあります。
34.79. listSystemEvents
- 名前
- listSystemEvents
- 説明
- 指定したシステムの全システムイベントを一覧表示します。これには、サーバー登録後のすべてのイベントが含まれます。呼び出し側で結果にフィルターをかけて探している特定イベントをフェッチする必要がある場合もあります。利用可能バージョン: 10.8 以降
- パラメーター
- string sessionKey
- int serverId - システム ID
- 戻り値
- array:
- struct - action
- int
failed_count
- アクションの失敗回数 - string
modified
- 修正日時 (modified_date に置換される予定) - dateTime.iso8601
modified_date
- 修正日時 - string
created
- 作成日時 (created_date に置換される予定) - dateTime.iso8601
created_date
- 作成日時 - string
action_type
- int
successful_count
- アクションの成功回数 - string
earliest_action
- アクションが予定される日時で最も早いもの - int
archived
- アクションが達成されたかどうか (1 または 0) - string
scheduler_user
- 具体的なユーザーがこのアクションをスケジュールした場合にのみ、利用可能 - string
prerequisite
- 前提条件のアクション (オプション) - string
name
- アクション名 - int
id
- アクション ID - string
version
- アクションのバージョン - string
completion_time
- イベントの完了日時。 フォーマットは ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0。 (オプション) (completed_date で置換される予定) - dateTime.iso8601
completed_date
- イベントの完了日時 (オプション) - string
pickup_time
- アクションのピックアップ日時。 フォーマットは ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0。 (オプション) (pickup_date で置換される予定) - dateTime.iso8601
pickup_date
- アクションのピックアップ日時 (オプション) - string
result_msg
- クライアントマシンでアクションが実行された後の結果文字列 (オプション) - array
additional_info
- このアレイには、利用可能な場合にイベントの追加情報が含まれます。- struct - info
- string
detail
- 提供される詳細は、特定のイベントに依存します。たとえば、パッケージイベントの場合はパッケージ名となり、エラーイベントの場合はアドバイザリー名および概要となり、設定ファイルイベントの場合はパスおよびオプションで改訂履歴となります。 - string
result
- 結果 (含まれる場合) は特定のイベントに依存します。たとえば、パッケージもしくはエラータイベントの場合は結果は含まれません。設定ファイルイベントの場合は結果にエラーが含まれたり (ファイルが見つからないなど、エラーが発生した場合)、設定ファイルの比較の場合は見つかった差異が含まれることがあります。
34.80. listSystems
- 名前
- listSystems
- 説明
- ユーザーに見えるすべてのサーバー一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.81. listSystemsWithExtraPackages
- 名前
- listSystemsWithExtraPackages
- 説明
- 追加パッケージを含むシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- システム ID - string
name
- システムのプロファイル名 - int
extra_pkg_count
- 追加パッケージ数
34.82. listSystemsWithPackage
- 名前
- listSystemsWithPackage
- 説明
- 指定したインストール済みパッケージがあるシステムを一覧表示します。
- パラメーター
- string sessionKey
- int pid - the package id
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.83. listSystemsWithPackage
- 名前
- listSystemsWithPackage
- 説明
- 指定したインストール済みパッケージがあるシステムを一覧表示します。
- パラメーター
- string sessionKey
- string name - パッケージ名
- string version - パッケージのバージョン
- string release - パッケージのリリース
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.84. listUngroupedSystems
- 名前
- listUngroupedSystems
- 説明
- どのシステムグループとも関連付けられていないシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.85. listUserSystems
- 名前
- listUserSystems
- 説明
- 指定したユーザーのシステムを一覧表示します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.86. listUserSystems
- 名前
- listUserSystems
- 説明
- ログインしているユーザーのシステムを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.87. listVirtualGuests
- 名前
- listVirtualGuests
- 説明
- 指定した仮想ホストの仮想ゲストを一覧表示します。
- パラメーター
- string sessionKey
- int sid - the virtual host's id
- 戻り値
- array:
- struct - virtual system
- int
id
- string
name
- string
guest_name
- 仮想ホストが提供する仮想ゲスト名 - dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
uuid
34.88. listVirtualHosts
- 名前
- listVirtualHosts
- 説明
- ユーザーに見える仮想ホストを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.89. obtainReactivationKey
- 名前
- obtainReactivationKey
- 説明
- このサーバーの再アクティベーションキーを取得します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- string
34.90. obtainReactivationKey
- 名前
- obtainReactivationKey
- 説明
- このサーバーの再アクティベーションキーを取得します。利用可能バージョン: 10.10 以降
- パラメーター
- string systemid - systemid file
- 戻り値
- string
34.91. provisionSystem
- 名前
- provisionSystem
- 説明
- 指定したキックスタートプロファイルでシステムをプロビジョニングします。
- パラメーター
- string sessionKey
- int serverId - プロビジョニングするシステムの ID
- string profileName - 使用するキックスタートプロファイル
- 戻り値
- int - スケジュールされているアクションの ID。それ以外は例外がスローされるかエラーが発生します。
34.92. provisionSystem
- 名前
- provisionSystem
- 説明
- 指定したキックスタートプロファイルでシステムをプロビジョニングします。
- パラメーター
- string sessionKey
- int serverId - プロビジョニングするシステムの ID
- string profileName - 使用するキックスタートプロファイル
- dateTime.iso8601 earliestDate
- 戻り値
- int - スケジュールされているアクションの ID。それ以外は例外がスローされるかエラーが発生します。
34.93. provisionVirtualGuest
- 名前
- provisionVirtualGuest
- 説明
- 指定したホスト上でゲストをプロビジョニングします。デフォルト値は、memory=512MB、vcpu=1、storage=3GB、mac_address=random となります。
- パラメーター
- string sessionKey
- int serverId - ゲストをプロビジョニングするホストの ID
- string guestName
- string profileName - 使用するキックスタートプロファイル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.94. provisionVirtualGuest
- 名前
- provisionVirtualGuest
- 説明
- 指定したホスト上でゲストをプロビジョニングします。これはゲスト作成をスケジュールし、ホストがチェックインするとプロビジョニングプロセスを開始します。または、OSAD が有効な場合、即座に開始します。デフォルト値は ac_address=random です。
- パラメーター
- string sessionKey
- int serverId - ゲストをプロビジョニングするホストの ID
- string guestName
- string profileName - 使用するキックスタートプロファイル
- int memoryMb - ゲストに割り当てるメモリーの容量
- int vcpus - ゲストに割り当てる仮想 CPU の数
- int storageGb - guest のディスクイメージサイズ
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.95. provisionVirtualGuest
- 名前
- provisionVirtualGuest
- 説明
- 指定したホスト上でゲストをプロビジョニングします。これはゲスト作成をスケジュールし、ホストがチェックインするとプロビジョニングプロセスを開始します。または、OSAD が有効な場合、即座に開始します。
- パラメーター
- string sessionKey
- int serverId - ゲストをプロビジョニングするホストの ID
- string guestName
- string profileName - 使用するキックスタートプロファイル
- int memoryMb - ゲストに割り当てるメモリーの容量
- int vcpus - ゲストに割り当てる仮想 CPU の数
- int storageGb - guest のディスクイメージサイズ
- string macAddress - ゲストの仮想ネットワークハードウェアに提供する macAddress
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.96. removeEntitlements
- 名前
- removeEntitlements
- 説明
- サーバーからアドオンエンタイトルメントを削除します。サーバーにないエンタイトルメントは無視されます。
- パラメーター
- string sessionKey
- int serverId
- array:
- string - entitlement_label
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.97. scheduleApplyErrata
- 名前
- scheduleApplyErrata
- 説明
- エラータ更新を複数システムに適用するアクションをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- array:
- int - serverId
- array:
- int - errataId
- 戻り値
- array:
- int - actionId
34.98. scheduleApplyErrata
- 名前
- scheduleApplyErrata
- 説明
- 指定した日時にエラータ更新を複数システムに適用するアクションをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- array:
- int - serverId
- array:
- int - errataId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.99. scheduleApplyErrata
- 名前
- scheduleApplyErrata
- 説明
- エラータ更新をシステムに適用するアクションをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- int serverId
- array:
- int - errataId
- 戻り値
- array:
- int - actionId
34.100. scheduleApplyErrata
- 名前
- scheduleApplyErrata
- 説明
- 指定した日時にエラータ更新をシステムに適用するアクションをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- int serverId
- array:
- int - errataId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.101. scheduleCertificateUpdate
- 名前
- scheduleCertificateUpdate
- 説明
- クライアント証明書の更新をスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.102. scheduleCertificateUpdate
- 名前
- scheduleCertificateUpdate
- 説明
- クライアント証明書の更新を指定した日時にスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- dateTime.iso860 date
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.103. scheduleGuestAction
- 名前
- scheduleGuestAction
- 説明
- 指定した日時に特定の仮想ゲストのゲストアクションをスケジュールします。
- パラメーター
- string sessionKey
- int sid - ゲストのシステム ID
- string state - 'start'、'suspend'、'resume'、'restart'、'shutdown' のいずれかのアクション
- dateTime.iso8601 date - アクションをスケジュールする日時
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.104. scheduleGuestAction
- 名前
- scheduleGuestAction
- 説明
- 現行の時間に特定の仮想ゲストのゲストアクションをスケジュールします。
- パラメーター
- string sessionKey
- int sid - ゲストのシステム ID
- string state - 'start'、'suspend'、'resume'、'restart'、'shutdown' のいずれかのアクション
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.105. scheduleHardwareRefresh
- 名前
- scheduleHardwareRefresh
- 説明
- システムのハードウェア更新をスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- int serverId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.106. schedulePackageInstall
- 名前
- schedulePackageInstall
- 説明
- 複数システムのパッケージインストールをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - serverId
- array:
- int - packageId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.107. schedulePackageInstall
- 名前
- schedulePackageInstall
- 説明
- システムのパッケージインストールをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- int serverId
- array:
- int - packageId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.108. schedulePackageInstallByNevra
- 名前
- schedulePackageInstallByNevra
- 説明
- 複数システムのパッケージインストールをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - serverId
- array:
- struct - Package nevra
- string
package_name
- string
package_epoch
- string
package_version
- string
package_release
- string
package_arch
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.109. schedulePackageInstallByNevra
- 名前
- schedulePackageInstallByNevra
- 説明
- システムのパッケージインストールをスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- array:
- struct - Package nevra
- string
package_name
- string
package_epoch
- string
package_version
- string
package_release
- string
package_arch
- dateTime.iso8601 earliestOccurrence
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.110. schedulePackageRefresh
- 名前
- schedulePackageRefresh
- 説明
- システムのパッケージ一覧更新をスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- int - スケジュールされているアクションの ID。それ以外は例外がスローされるかエラーが発生します。
34.111. schedulePackageRemove
- 名前
- schedulePackageRemove
- 説明
- 複数システムのパッケージ削除をスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - serverId
- array:
- int - packageId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.112. schedulePackageRemove
- 名前
- schedulePackageRemove
- 説明
- システムのパッケージ削除をスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- array:
- int - packageId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.113. schedulePackageRemoveByNevra
- 名前
- schedulePackageRemoveByNevra
- 説明
- 複数システムのパッケージ削除をスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - serverId
- array:
- struct - Package nevra
- string
package_name
- string
package_epoch
- string
package_version
- string
package_release
- string
package_arch
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.114. schedulePackageRemoveByNevra
- 名前
- schedulePackageRemoveByNevra
- 説明
- システムのパッケージ削除をスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- array:
- struct - Package nevra
- string
package_name
- string
package_epoch
- string
package_version
- string
package_release
- string
package_arch
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
34.115. scheduleReboot
- 名前
- scheduleReboot
- 説明
- システムの再起動をスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- int serverId
- dateTime.iso860 earliestOccurrence
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.116. scheduleScriptRun
- 名前
- scheduleScriptRun
- 説明
- 実行するスクリプトファイルをスケジュールします。
- パラメーター
- string sessionKey
- string label
- array:
- int - スクリプトを実行するサーバーのシステム ID
- string username - スクリプトを実行するユーザー
- string groupname - スクリプトを実行するグループ
- int timeout - タイムアウトになるまでのスクリプト実行時間 (秒)
- string script - 実行するスクリプトのコンテンツ
- dateTime.iso8601 earliestOccurrence - スクリプトが実行可能な最も早い日時
- 戻り値
- int - 作成されたスクリプト実行アクションの ID。system.getScriptResults での結果のフェッチに使用可能。
34.117. scheduleScriptRun
- 名前
- scheduleScriptRun
- 説明
- 実行するスクリプトファイルをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - スクリプトを実行するサーバーのシステム ID
- string username - スクリプトを実行するユーザー
- string groupname - スクリプトを実行するグループ
- int timeout - タイムアウトになるまでのスクリプト実行時間 (秒)
- string script - 実行するスクリプトのコンテンツ
- dateTime.iso8601 earliestOccurrence - スクリプトが実行可能な最も早い日時
- 戻り値
- int - 作成されたスクリプト実行アクションの ID。system.getScriptResults での結果のフェッチに使用可能。
34.118. scheduleScriptRun
- 名前
- scheduleScriptRun
- 説明
- 実行するスクリプトファイルをスケジュールします。
- パラメーター
- string sessionKey
- int serverId - スクリプトを実行するサーバー ID
- string username - スクリプトを実行するユーザー
- string groupname - スクリプトを実行するグループ
- int timeout - タイムアウトになるまでのスクリプト実行時間 (秒)
- string script - 実行するスクリプトのコンテンツ
- dateTime.iso8601 earliestOccurrence - スクリプトが実行可能な最も早い日時
- 戻り値
- int - 作成されたスクリプト実行アクションの ID。system.getScriptResults での結果のフェッチに使用可能。
34.119. scheduleScriptRun
- 名前
- scheduleScriptRun
- 説明
- 実行するスクリプトファイルをスケジュールします。
- パラメーター
- string sessionKey
- string label
- int serverId - スクリプトを実行するサーバー ID
- string username - スクリプトを実行するユーザー
- string groupname - スクリプトを実行するグループ
- int timeout - タイムアウトになるまでのスクリプト実行時間 (秒)
- string script - 実行するスクリプトのコンテンツ
- dateTime.iso8601 earliestOccurrence - スクリプトが実行可能な最も早い日時
- 戻り値
- int - 作成されたスクリプト実行アクションの ID。system.getScriptResults での結果のフェッチに使用可能。
34.120. scheduleSyncPackagesWithSystem
- 名前
- scheduleSyncPackagesWithSystem
- 説明
- ソースシステムからターゲットにパッケージを同期します。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- int targetServerId - パッケージ変更を適用するターゲットシステム
- int sourceServerId - パッケージの状態の取得元となるソースシステム
- array:
- int - packageId - 同期するパッケージ ID
- dateTime.iso8601 date - アクションをスケジュールする日時
- 戻り値
- int actionId - 予定されるアクションのアクション ID
34.121. searchByName
- 名前
- searchByName
- 説明
- 提供された正規表現 (正規表現の Java 表現で定義) に名前が一致するシステム ID 一覧を返します。
- パラメーター
- string sessionKey
- string regexp - 正規表現
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
34.122. sendOsaPing
- 名前
- sendOsaPing
- 説明
- OSA を使用しているシステムに ping を送信します
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.123. setBaseChannel
- 名前
- setBaseChannel
- 説明
- サーバーを新規 baseChannel に割り当てます。廃止予定 - system.setBaseChannel(string sessionKey、int serverId、string channelLabel) に置換されます。
- パラメーター
- string sessionKey
- int serverId
- int channelId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.124. setBaseChannel
- 名前
- setBaseChannel
- 説明
- 新規ベースチャンネルにサーバーを割り当てます。ユーザーが channelLabel に空の文字列を提供した場合は、現行のベースチャンネルとすべての子チャンネルはシステムから削除されます。
- パラメーター
- string sessionKey
- int serverId
- string channelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.125. setChildChannels
- 名前
- setChildChannels
- 説明
- 指定したサーバーが提供された子チャンネルをサブスクライブするようにします。このメソッドは、サーバーが現在サブスクライブしている子チャンネルのうち、リストに含まれていないものをサブスクライブ解除します。ユーザーは、チャンネル ID 一覧 (int) かチャンネルラベル一覧 (string) を入力することができます。
- パラメーター
- string sessionKey
- int serverId
- array:
- int (廃止予定) または string - channelId (廃止予定) または channelLabel
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.126. setCustomValues
- 名前
- setCustomValues
- 説明
- 指定したサーバーにカスタム値を設定します。
- パラメーター
- string sessionKey
- int serverId
- struct - カスタムラベルからカスタム値へのマップ
- string
custom info label
- string
value
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.127. setDetails
- 名前
- setDetails
- 説明
- サーバーの詳細を設定します。引数はすべてオプションで、struct に含まれている場合にのみ、修正されます。
- パラメーター
- string sessionKey
- int serverId - 詳細の検索先となるサーバーの ID
- struct - server details
- string
profile_name
- システムのプロファイル名 - string
base_entitlement
- システムのベースエンタイトルメントラベル (enterprise_entitled または sw_mgr_entitled) - boolean
auto_errata_update
- システムので自動エラータ更新が有効になっている場合は、true - string
description
- システムの説明 - string
address1
- システムのアドレス行 1 - string
address2
- システムのアドレス行 2 - string
city
- string
state
- string
country
- string
building
- string
room
- string
rack
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.128. setGroupMembership
- 名前
- setGroupMembership
- 説明
- 指定したグループでサーバーメンバーシップを設定します。
- パラメーター
- string sessionKey
- int serverId
- int serverGroupId
- boolean member - 指定したサーバーを指定したサーバーグループに割り当てる場合は '1'、指定したサーバーグループから指定したサーバーを削除する場合は '0'
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.129. setGuestCpus
- 名前
- setGuestCpus
- 説明
- ゲストのホストのアクションをスケジュールして、そのゲストの CPU 割り当てを設定します。
- パラメーター
- string sessionKey
- int sid - ゲストのシステム ID
- int numOfCpus - ゲストに割り当てる仮想 cpu の数
- 戻り値
- int actionID - ホストシステム上のスケジュールアクションのアクション ID
34.130. setGuestMemory
- 名前
- setGuestMemory
- 説明
- ゲストのホストのアクションをスケジュールして、そのゲストのメモリー割り当てを設定します。
- パラメーター
- string sessionKey
- int sid - ゲストのシステム ID
- int memory - ゲストに割り当てるメモリーの容量
- 戻り値
- int actionID - ホストシステム上のスケジュールアクションのアクション ID
34.131. setLockStatus
- 名前
- setLockStatus
- 説明
- サーバーのロックステータスを設定します。
- パラメーター
- string sessionKey
- int serverId
- boolean lockStatus - システムをロックする場合は true、ロック解除する場合は false
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.132. setPrimaryInterface
- 名前
- setPrimaryInterface
- 説明
- 新規プライマリーネットワークインターフェースを設定します。
- パラメーター
- string sessionKey
- int serverId
- string interfaceName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.133. setProfileName
- 名前
- setProfileName
- 説明
- サーバーのプロファイル名を設定します。
- パラメーター
- string sessionKey
- int serverId
- string name - プロファイル名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.134. setVariables
- 名前
- setVariables
- 説明
- 指定したサーバーの cobbler システムレコードに設定されているキックスタート変数一覧を設定します。この呼び出しは、指定したシステムの cobbler にシステムレコードが存在することを前提としており、存在しない場合は XMLRPC エラーが発生します。XMLRPC でシステムレコードを作成する場合は、system.createSystemRecord を使用します。Web UI でシステムレコードを作成するには、System -> <Specified System> -> Provisioning -> Select a Kickstart profile -> Create Cobbler System Record に移動します。
- パラメーター
- string sessionKey
- int serverId
- boolean netboot
- array:
- struct - kickstart variable
- string
key
- string or int
value
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.135. tagLatestSnapshot
- 名前
- tagLatestSnapshot
- 説明
- 最新のシステムスナップショットをタグ付けします。
- パラメーター
- string sessionKey
- int serverId
- string tagName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.136. unentitle
- 名前
- unentitle
- 説明
- システムのエンタイトルメントを完全に解除します。
- パラメーター
- string systemid - systemid file
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.137. upgradeEntitlement
- 名前
- upgradeEntitlement
- 説明
- 指定したサーバーにエンタイトルメントを追加します。
- パラメーター
- string sessionKey
- int serverId
- string entitlementName - 'enterprise_entitled', 'provisioning_entitled'、'virtualization_host'、'virtualization_host_platform' のいずれか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
34.138. whoRegistered
- 名前
- whoRegistered
- 説明
- システムを登録したユーザー情報を返します。
- パラメーター
- string sessionKey
- int sid - 対象システムの ID
- 戻り値
- struct - user
- int
id
- string
login
- string
login_uc
- ログインの大文字バージョン - boolean
enabled
- ユーザーが有効な場合は true、無効な場合は false
第35章 system.config
概要
設定チャンネルの各側面およびサーバーの関連付け、基本的に system.config ネームスペースにアクセス、修正するメソッドを提供します。
35.1. addChannels
- 名前
- addChannels
- 説明
- サーバーと設定チャンネルの一覧を指定すると、このメソッドはその設定チャンネルをシステムがサブスクライブしている設定チャンネルの一番上または一番下 (どちらか指定した方) に追加します。追加リストで提供されている設定チャンネルの順序は、追加の際にも維持されます。追加リストにある設定チャンネルのいずれかをサーバーがサブスクライブしている場合は、設定チャンネルは適切な場所に再度順位付けされます。
- パラメーター
- string sessionKey
- array:
- int - チャンネルの追加先となるシステムの ID
- array:
- string - 順位どおりの設定チャンネルラベルの一覧
- boolean addToTop
- true - 指定されたチャンネル一覧をサーバーの設定チャンネルリストの最初に追加します
- false - 指定されたチャンネル一覧をサーバーの設定チャンネルリストの最後に追加します
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
35.2. createOrUpdatePath
- 名前
- createOrUpdatePath
- 説明
- 指定されたパスで新規ファイル (text または binary) またはディレクトリーを作成するか、サーバー上の既存パスを更新します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- int serverId
- string path - 設定ファイル/ディレクトリーパス
- boolean isDir
- True - パスがディレクトリーの場合
- False - パスがファイルの場合
- struct - path info
- string
contents
- ファイルのコンテンツ (テキストまたはバイナリの場合は base64 によるエンコード)。(ディレクトリー以外の場合のみ) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 (デフォルト: disabled、ディレクトリー以外の場合のみ) - string
owner
- ファイル/ディレクトリーの所有者 - string
group
- ファイル/ディレクトリーのグループ名 - string
permissions
- 8 進数によるファイル/ディレクトリーのパーミッション (例: 644) - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。デフォルト値を受け付けるには、null または空の文字列を使用します。(ディレクトリー以外の場合のみ) - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。デフォルト値を受け付けるには、null または空の文字列を使用します。(ディレクトリー以外の場合のみ) - string
selinux_ctx
- SELinux コンテキスト (オプション) - int
revision
- 次の改訂番号、null の場合は自動増加 - boolean
binary
- バイナリコンテンツをマーク。True の場合は、base64 エンコード化されたコンテンツが予想されます (ディレクトリー以外の場合のみ)
- int commitToLocal
- 1 - 設定ファイルをシステムのローカル上書き設定チャンネルにコミット
- 0 - 設定ファイルをシステムの sandbox 設定チャンネルにコミット
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
35.3. createOrUpdateSymlink
- 名前
- createOrUpdateSymlink
- 説明
- 指定されたパスで新規のシンボリックリンクを作成するか、既存のパスを更新します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- int serverId
- string path - 設定ファイル/ディレクトリーパス
- struct - path info
- string
target_path
- シンボリックリンクのターゲットパス。 - string
selinux_ctx
- SELinux Security コンテキスト (オプション) - int
revision
- 次の改訂番号、null の場合は自動増加
- int commitToLocal
- 1 - 設定ファイルをシステムのローカル上書き設定チャンネルにコミット
- 0 - 設定ファイルをシステムの sandbox 設定チャンネルにコミット
- 戻り値
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
35.4. deleteFiles
- 名前
- deleteFiles
- 説明
- サーバーのローカルまたは sandbox チャンネルからファイルパスを削除します。
- パラメーター
- string sessionKey
- int serverId
- array:
- string - 削除するパス
- boolean deleteFromLocal
- True - 設定ファイルパスをシステムの上書き設定チャンネルから削除します
- False - 設定ファイルパスをシステムの sandbox 設定チャンネルから削除します
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
35.5. deployAll
- 名前
- deployAll
- 説明
- 指定したシステム一覧上の全設定ファイルにデプロイアクションをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - 設定ファイルデプロイメントをスケジュールするシステムの ID
- dateTime.iso8601 date - デプロイアクションの最も早い日時
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
35.6. listChannels
- 名前
- listChannels
- 説明
- システムに関連付けられているすべてのグローバル設定チャンネルをランク順に一覧表示します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- 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
35.7. listFiles
- 名前
- listFiles
- 説明
- 指定したチャンネル内のファイル一覧が返されます。
- パラメーター
- string sessionKey
- int serverId
- int listLocal
- 1 - システムのローカル上書き設定チャンネル内の設定ファイルを返します。
- 0 - システムの sandbox 設定チャンネル内の設定ファイルを返します。
- 戻り値
- array:
- struct - Configuration File information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
channel_label
- このファイルがある中央設定チャンネルのラベル。このエントリーは、ファイルが中央チャンネルに上書きされていない場合にのみ、表示されます。 - struct
channel_type
- struct - Configuration Channel Type information
- int
id
- string
label
- string
name
- int
priority
- dateTime.iso8601
last_modified
- 最終修正日
35.8. lookupFileInfo
- 名前
- lookupFileInfo
- 説明
- パスとチャンネルのリストを指定すると、最新バージョンのパスの詳細を返します。利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- int serverId
- array:
- string - 検索するパス
- int searchLocal
- 1 - 設定ファイルパスをシステムのローカル上書き設定またはシステムがサブスクライブしている中央チャンネルで検索します
- 0 - システムの sandbox 設定チャンネル内で設定ファイルパスを検索します。
- 戻り値
- array:
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
35.9. removeChannels
- 名前
- removeChannels
- 説明
- 指定されたサーバーから設定チャンネルを削除します。
- パラメーター
- string sessionKey
- array:
- int - 設定チャンネルを削除するシステムの ID
- array:
- string - 削除する設定チャンネルラベル一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
35.10. setChannels
- 名前
- setChannels
- 説明
- 指定したサーバー上の既存の設定チャンネルを置換します。チャンネルは、configChannelLabels アレイの順序でランク付けされます。
- パラメーター
- string sessionKey
- array:
- int - チャンネルを設定するシステムの ID
- array:
- string - 順位どおりの設定チャンネルラベルの一覧
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第36章 system.crash
概要
ソフトウェアのクラッシュ情報にアクセス、修正するメソッドを提供します。
36.1. createCrashNote
- 名前
- createCrashNote
- 説明
- クラッシュノートを作成します。
- パラメーター
- string sessionKey
- int crashId
- string subject
- string details
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
36.2. deleteCrash
- 名前
- deleteCrash
- 説明
- 指定したクラッシュ ID のクラッシュを削除します。
- パラメーター
- string sessionKey
- int crashId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
36.3. deleteCrashNote
- 名前
- deleteCrashNote
- 説明
- クラッシュノートを削除します。
- パラメーター
- string sessionKey
- int crashNoteId
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
36.4. getCrashCountInfo
- 名前
- getCrashCountInfo
- 説明
- 指定したシステムの最新のソフトウェアクラッシュレポートの日付を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- struct - Crash Count Information
- int
total_count
- システムのソフトウェアクラッシュ合計数 - int
unique_count
- システムにおける一意のソフトウェアクラッシュ合計数 - dateTime.iso8601
last_report
- ソフトウェアクラッシュレポートの最終日時
36.5. getCrashFile
- 名前
- getCrashFile
- 説明
- クラッシュファイルをダウンロードします。
- パラメーター
- string sessionKey
- int crashFileId
- 戻り値
- base64 - base64 エンコードされたクラッシュファイル
36.6. getCrashFileUrl
- 名前
- getCrashFileUrl
- 説明
- クラッシュファイルのダウンロード URL を取得します。
- パラメーター
- string sessionKey
- int crashFileId
- 戻り値
- string - クラッシュファイルのダウンロード URL
36.7. getCrashNotesForCrash
- 名前
- getCrashNotesForCrash
- 説明
- クラッシュのクラッシュノートを一覧表示します。
- パラメーター
- string sessionKey
- int crashId
- 戻り値
- array:
- struct - crashNote
- int
id
- string
subject
- string
details
- string
updated
36.8. getCrashOverview
- 名前
- getCrashOverview
- 説明
- ソフトウェアクラッシュ概要を取得します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - crash
- string
uuid
- クラッシュ UUID - string
component
- パッケージコンポーネント (一意および空でない設定の場合) - int
crash_count
- 発生したクラッシュ数 - int
system_count
- 影響のあったシステム数 - dateTime.iso8601
last_report
- 最終クラッシュの発生日時
36.9. getCrashesByUuid
- 名前
- getCrashesByUuid
- 説明
- 指定した UUID のソフトウェアクラッシュを一覧表示します。
- パラメーター
- string sessionKey
- string uuid
- 戻り値
- array:
- struct - crash
- int
server_id
- クラッシュが発生したサーバー ID - string
server_name
- クラッシュが発生したサーバー名 - int
crash_id
- 指定した UUID のクラッシュ ID - int
crash_count
- 指定した UUID で発生したクラッシュの回数 - string
crash_component
- クラッシュのコンポーネント - dateTime.iso8601
last_report
- 最終クラッシュの発生日時
36.10. listSystemCrashFiles
- 名前
- listSystemCrashFiles
- 説明
- 指定したクラッシュ ID のクラッシュファイル一覧を返します。
- パラメーター
- string sessionKey
- int crashId
- 戻り値
- array:
- struct - crashFile
- int
id
- string
filename
- string
path
- int
filesize
- boolean
is_uploaded
- date
created
- date
modified
36.11. listSystemCrashes
- 名前
- listSystemCrashes
- 説明
- システムのソフトウェアクラッシュ一覧を返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - crash
- int
id
- string
crash
- string
path
- int
count
- string
uuid
- string
analyzer
- string
architecture
- string
cmdline
- string
component
- string
executable
- string
kernel
- string
reason
- string
username
- date
created
- date
modified
第37章 system.custominfo
概要
カスタムシステム情報にアクセス、修正するメソッドを提供します。
37.1. createKey
- 名前
- createKey
- 説明
- 新規カスタムキーを作成します。
- パラメーター
- string sessionKey
- string keyLabel - 新規キーのラベル
- string keyDescription - 新規キーの説明
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
37.2. deleteKey
- 名前
- deleteKey
- 説明
- 既存のカスタムキーとそのキーのシステムの値すべてを削除します。
- パラメーター
- string sessionKey
- string keyLabel - 新規キーのラベル
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
37.3. listAllKeys
- 名前
- listAllKeys
- 説明
- ユーザーの組織に定義されたカスタム情報キーを一覧表示します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - custom info
- int
id
- string
label
- string
description
- int
system_count
- dateTime.iso8601
last_modified
37.4. updateKey
- 名前
- updateKey
- 説明
- カスタムキーの説明を更新します。
- パラメーター
- string sessionKey
- string keyLabel - 変更するキー
- string keyDescription - 新規キーの説明
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第38章 system.provisioning.snapshot
概要
システムスナップショットにアクセス、削除するメソッドを提供します。
38.1. addTagToSnapshot
- 名前
- addTagToSnapshot
- 説明
- スナップショットにタグを追加します
- パラメーター
- string sessionKey
- int snapshotId - スナップショットの ID
- string tag - スナップショットタグの名前
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
38.2. deleteSnapshot
- 名前
- deleteSnapshot
- 説明
- 指定したスナップショット ID のスナップショットを削除します。利用可能バージョン: 10.1 以降
- パラメーター
- string sessionKey
- int snapshotId - 削除するスナップショットの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
38.3. deleteSnapshots
- 名前
- deleteSnapshots
- 説明
- 指定した日付に基づいて複数システムのすべてのスナップショットを削除します。例を示します。
- startDate のみを指定した場合は、その日付移行に作成されたすべてのスナップショットが削除されます。
- startDate と endDate を指定した場合は、その日付の間の期間に作成されたすべてのスナップショットが削除されます。
- startDate と endDate が指定されない場合は、すべてのスナップショットが削除されます。
利用可能バージョン: 10.1 以降 - パラメーター
- string sessionKey
- struct - date details
- dateTime.iso8601
startDate
- endDate が指定される場合を除いてオプションになります。 - dateTime.iso8601
endDate
- オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
38.4. deleteSnapshots
- 名前
- deleteSnapshots
- 説明
- 日付に基づいて単一システムのすべてのスナップショットを削除します。例を示します。
- startDate のみを指定した場合は、その日付移行に作成されたすべてのスナップショットが削除されます。
- startDate と endDate を指定した場合は、その日付の間の期間に作成されたすべてのスナップショットが削除されます。
- startDate と endDate が指定されない場合は、サーバーに関連付けられているすべてのスナップショットが削除されます。
利用可能バージョン: 10.1 以降 - パラメーター
- string sessionKey
- int sid - スナップショットを削除するシステムのシステム ID
- struct - date details
- dateTime.iso8601
startDate
- endDate が指定される場合を除いてオプションになります。 - dateTime.iso8601
endDate
- オプション
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
38.5. listSnapshotConfigFiles
- 名前
- listSnapshotConfigFiles
- 説明
- スナップショットに関連付けられている設定ファイル一覧利用可能バージョン: 10.2 以降
- パラメーター
- string sessionKey
- int snapId
- 戻り値
- array:
- struct - Configuration Revision information
- string
type
- file
- directory
- symlink
- string
path
- ファイルのパス - string
target_path
- シンボリックリンクのターゲットファイルパス。シンボリックリンクにのみ存在。 - string
channel
- チャンネル名 - string
contents
- ファイルコンテンツ (contents_enc64 属性に従った base64 エンコード化) - boolean
contents_enc64
- base64 でエンコード化されたコンテンツを特定 - int
revision
- ファイル改訂 - dateTime.iso8601
creation
- 作成日 - dateTime.iso8601
modified
- 最終修正日 - string
owner
- ファイル所有者。ファイルまたはディレクトリーにのみ存在。 - string
group
- ファイルグループ。ファイルまたはディレクトリーにのみ存在。 - int
permissions
- ファイルのパーミッション (廃止予定)。ファイルまたはディレクトリーにのみ存在。 - string
permissions_mode
- ファイルのパーミッション。ファイルまたはディレクトリーにのみ存在。 - string
selinux_ctx
- SELinux コンテキスト (オプション)。 - boolean
binary
- true/false、ファイルにのみ存在。 - string
sha256
- ファイルの sha256 署名。ファイルにのみ存在。 - string
macro-start-delimiter
- 設定ファイルのマクロ開始区切り文字。テキストファイルにのみ存在。 - string
macro-end-delimiter
- 設定ファイルのマクロ終了区切り文字。テキストファイルにのみ存在。
38.6. listSnapshotPackages
- 名前
- listSnapshotPackages
- 説明
- スナップショットに関連付けられているパッケージを一覧表示します。利用可能バージョン: 10.1 以降
- パラメーター
- string sessionKey
- int snapId
- 戻り値
- array:
- struct - package nvera
- string
name
- string
epoch
- string
version
- string
release
- string
arch
38.7. listSnapshots
- 名前
- listSnapshots
- 説明
- 指定したシステムのスナップショットを一覧表示します。表示するスナップショットを限定するには、オプションで開始日および終了日を指定することもできます。例を示します。
- startDate のみを指定した場合は、その日付移行に作成されたすべてのスナップショットが返されます。
- startDate と endDate を指定した場合は、その日付の間の期間に作成されたすべてのスナップショットが返されます。
- startDate と endDate が指定されない場合は、サーバーに関連付けられているすべてのスナップショットが返されます。
利用可能バージョン: 10.1 以降 - パラメーター
- string sessionKey
- int serverId
- struct - date details
- dateTime.iso8601
startDate
- endDate が指定される場合を除いてオプションになります。 - dateTime.iso8601
endDate
- オプション
- 戻り値
- array:
- struct - server snapshot
- int
id
- string
reason
- スナップショットが存在する理由 - dateTime.iso8601
created
- array
channels
- string - スナップショットに関連付けられているチャンネルのラベル
- array
groups
- string - スナップショットに関連付けられているサーバーグループの名前
- array
entitlements
- string - スナップショットに関連付けられているシステムエンタイトルメントの名前
- array
config_channels
- string - スナップショットに関連付けられている設定チャンネルのラベル
- array
tags
- string - スナップショットに関連付けられているタグ名
- string
Invalid_reason
- スナップショットが無効の場合は、これが理由です (オプション)
38.8. rollbackToSnapshot
- 名前
- rollbackToSnapshot
- 説明
- サーバーをスナップショットにロールバックします
- パラメーター
- string sessionKey
- int serverId
- int snapshotId - スナップショットの ID
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
38.9. rollbackToTag
- 名前
- rollbackToTag
- 説明
- サーバーをスナップショットにロールバックします
- パラメーター
- string sessionKey
- int serverId
- string tagName - スナップショットタグの名前
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
38.10. rollbackToTag
- 名前
- rollbackToTag
- 説明
- サーバーをスナップショットにロールバックします
- パラメーター
- string sessionKey
- string tagName - スナップショットタグの名前
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第39章 system.scap
概要
SCAP スキャンをスケジュールし、結果にアクセスするメソッドを提供します。
39.1. deleteXccdfScan
- 名前
- deleteXccdfScan
- 説明
- OpenSCAP XCCDF スキャンを Spacewalk データベースから削除します。保持期間が終了した SCAP スキャンのみ、削除できることに注意してください。
- パラメーター
- string sessionKey
- int XCCDF スキャンの ID (xid)
- 戻り値
- boolean - 操作が成功したことを示します。
39.2. getXccdfScanDetails
- 名前
- getXccdfScanDetails
- 説明
- 選択した OpenSCAP XCCDF スキャンの詳細を取得します。
- パラメーター
- string sessionKey
- int XCCDF スキャンの ID (xid)
- 戻り値
- struct - OpenSCAP XCCDF Scan
- int
xid
- XCCDF TestResult id - int
sid
- serverId - int
action_id
- 親アクションの ID - string
path
- XCCDF ドキュメントへのパス - string
oscap_parameters
- oscap コマンドライン引数 - string
test_result
- XCCDF TestResult の識別子 - string
benchmark
- XCCDF Benchmark の識別子 - string
benchmark_version
- Benchmark のバージョン - string
profile
- XCCDF Profile の識別子 - string
profile_title
- XCCDF Profile のタイトル - dateTime.iso8601
start_time
- スキャン開始時のクライアントマシンの時間 - dateTime.iso8601
end_time
- スキャン完了時のクライアントマシンの時間 - string
errors
- スキャンの Stderr 出力 - bool
deletable
- スキャンが削除可能かどうかを示します。
39.3. getXccdfScanRuleResults
- 名前
- getXccdfScanRuleResults
- 説明
- 特定 OpenSCAP XCCDF スキャン向けの RuleResults の完全リストを返します。
- パラメーター
- string sessionKey
- int XCCDF スキャンの ID (xid)
- 戻り値
- array:
- struct - OpenSCAP XCCDF RuleResult
- string
idref
- XCCDF ドキュメントからの idref - string
result
- 評価の結果 - string
idents
- XCCDF idents のコンマ区切り一覧。
39.4. listXccdfScans
- 名前
- listXccdfScans
- 説明
- 特定システム向けの終了した OpenSCAP スキャンのリストを返します。
- パラメーター
- string sessionKey
- int serverId
- 戻り値
- array:
- struct - OpenSCAP XCCDF Scan
- int
xid
- XCCDF TestResult ID - string
profile
- XCCDF Profile - string
path
- XCCDF ドキュメントへのパス - dateTime.iso8601
completed
- スキャンの完了時間
39.5. scheduleXccdfScan
- 名前
- scheduleXccdfScan
- 説明
- OpenSCAP スキャンをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - serverId
- string ターゲットシステム上での xccdf コンテンツへのパス
- string oscap ツール用の追加パラメーター
- 戻り値
- int - SCAP アクションが作成された場合の ID
39.6. scheduleXccdfScan
- 名前
- scheduleXccdfScan
- 説明
- OpenSCAP スキャンをスケジュールします。
- パラメーター
- string sessionKey
- array:
- int - serverId
- string ターゲットシステム上での xccdf コンテンツへのパス
- string oscap ツール用の追加パラメーター
- dateTime.iso8601 date - アクションをスケジュールする日付
- 戻り値
- int - SCAP アクションが作成された場合の ID
39.7. scheduleXccdfScan
- 名前
- scheduleXccdfScan
- 説明
- Scap XCCDF スキャンをスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- string ターゲットシステム上での xccdf コンテンツへのパス
- string oscap ツール用の追加パラメーター
- 戻り値
- int - 作成された scap アクションの ID
39.8. scheduleXccdfScan
- 名前
- scheduleXccdfScan
- 説明
- Scap XCCDF スキャンをスケジュールします。
- パラメーター
- string sessionKey
- int serverId
- string ターゲットシステム上での xccdf コンテンツへのパス
- string oscap ツール用の追加パラメーター
- dateTime.iso8601 date - アクションをスケジュールする日付
- 戻り値
- int - 作成された scap アクションの ID
第40章 system.search
概要
検索サーバーを使用してシステム検索リクエストを実行するメソッドが含まれます。
40.1. deviceDescription
- 名前
- deviceDescription
- 説明
- デバイスの説明に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.2. deviceDriver
- 名前
- deviceDriver
- 説明
- デバイスドライバーに合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.3. deviceId
- 名前
- deviceId
- 説明
- デバイス ID に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.4. deviceVendorId
- 名前
- deviceVendorId
- 説明
- デバイス vendor_id に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.5. hostname
- 名前
- hostname
- 説明
- ホスト名に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.6. ip
- 名前
- ip
- 説明
- IP に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.7. nameAndDescription
- 名前
- nameAndDescription
- 説明
- 名前または説明に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
40.8. uuid
- 名前
- uuid
- 説明
- UUID に合致するシステムを一覧表示します。
- パラメーター
- string sessionKey
- string searchTerm
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - string
hostname
- string
ip
- string
hw_description
- null でない場合のハードウェアの説明 - string
hw_device_id
- null でない場合のハードウェアデバイスの ID - string
hw_vendor_id
- null でない場合のハードウェアベンダーの ID - string
hw_driver
- null でない場合のハードウェアドライバー
第41章 systemgroup
概要
システムグループにアクセス、修正するメソッドを提供します。
41.1. addOrRemoveAdmins
- 名前
- addOrRemoveAdmins
- 説明
- 指定したグループから管理者を削除する、またはグループに管理者を追加します。Satellite および組織の管理者には、デフォルトで組織内のグループへのアクセスが付与されています。このため、これらのロールがあるユーザーは、提供されるアレイには含まれるべきではありません。発信者は組織の管理者である必要があります。
- パラメーター
- string sessionKey
- string systemGroupName
- array:
- string - loginName - ユーザーのログイン名
- int add - 管理者の追加には 1、削除には 0
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
41.2. addOrRemoveSystems
- 名前
- addOrRemoveSystems
- 説明
- 指定したサーバーをシステムグループに追加、またはグループから削除します。
- パラメーター
- string sessionKey
- string systemGroupName
- array:
- int - serverId
- boolean add - グループを追加する場合は true、削除する場合は false
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
41.3. create
- 名前
- create
- 説明
- 新規システムグループを作成します
- パラメーター
- string sessionKey
- string name - システムグループの名前。
- string description - システムグループの説明
- 戻り値
- struct - Server Group
- int
id
- string
name
- string
description
- int
org_id
- int
system_count
41.4. delete
- 名前
- delete
- 説明
- システムグループを削除します
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
41.5. getDetails
- 名前
- getDetails
- 説明
- ID に基づいてサーバーグループの詳細を取得します。
- パラメーター
- string sessionKey
- int systemGroupId
- 戻り値
- struct - Server Group
- int
id
- string
name
- string
description
- int
org_id
- int
system_count
41.6. getDetails
- 名前
- getDetails
- 説明
- 名前に基づいてサーバーグループの詳細を取得します。
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- struct - Server Group
- int
id
- string
name
- string
description
- int
org_id
- int
system_count
41.7. listActiveSystemsInGroup
- 名前
- listActiveSystemsInGroup
- 説明
- サーバーグループ内のアクティブなシステムを一覧表示します。
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- array:
- int - server_id
41.8. listAdministrators
- 名前
- listAdministrators
- 説明
- 指定したグループを管理できるユーザー一覧を返します。発信者はシステムグループ管理者か組織の管理者である必要があります。
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- array:
- struct - user
- int
id
- string
login
- string
login_uc
- ログインの大文字バージョン - boolean
enabled
- ユーザーが有効な場合は true、無効な場合は false
41.9. listAllGroups
- 名前
- listAllGroups
- 説明
- ログインしているユーザーがアクセス可能なシステムグループの一覧を取得します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - Server Group
- int
id
- string
name
- string
description
- int
org_id
- int
system_count
41.10. listGroupsWithNoAssociatedAdmins
- 名前
- listGroupsWithNoAssociatedAdmins
- 説明
- 管理者を持たないシステムグループの一覧を返します (管理者は暗示的にシステムグループへのアクセスがあるため、組織の管理者ではありません)。発信者は組織の管理者である必要があります。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - Server Group
- int
id
- string
name
- string
description
- int
org_id
- int
system_count
41.11. listInactiveSystemsInGroup
- 名前
- listInactiveSystemsInGroup
- 説明
- 指定した非アクティブな時間を使用して、サーバーグループ内の非アクティブシステムを一覧表示します。
- パラメーター
- string sessionKey
- string systemGroupName
- int daysInactive - システムが非アクティブとみなされるまでチェックインしない日数
- 戻り値
- array:
- int - server_id
41.12. listInactiveSystemsInGroup
- 名前
- listInactiveSystemsInGroup
- 説明
- デフォルトの 1 日のしきい値を使用して、サーバーグループ内の非アクティブシステムを一覧表示します。
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- array:
- int - server_id
41.13. listSystems
- 名前
- listSystems
- 説明
- システムグループに関連付けられているシステム一覧を返します。ユーザーがこのシステムグループにアクセスできる必要があります。
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- array:
- struct - server details
- int
id
- システム ID - string
profile_name
- string
base_entitlement
- システムのベースエンタイトルメントラベル (enterprise_entitled または sw_mgr_entitled) - array
string
- addon_entitlements - システムのアドオンエンタイトルメントラベル。以下を含みます: provisioning_entitled、virtualization_host、virtualization_host_platform
- boolean
auto_update
- システムので自動エラータ更新が有効になっている場合は、true - string
release
- オペレーティングシステムのリリース (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
- 'unknown'、'offline'、'online' のいずれか。 - boolean
lock_status
- システムがロックされている場合は True。システムがロックされていない場合は False。 - string
virtualization
- 仮想化のタイプ。仮想ゲストのみ (オプション)
41.14. listSystemsMinimal
- 名前
- listSystemsMinimal
- 説明
- システムグループに関連付けられているシステム一覧を返します。ユーザーがこのシステムグループにアクセスできる必要があります。
- パラメーター
- string sessionKey
- string systemGroupName
- 戻り値
- array:
- struct - system
- int
id
- string
name
- dateTime.iso8601
last_checkin
- サーバーが最後にチェックインに成功した日時 - dateTime.iso8601
last_boot
- サーバーの最終起動日時 - dateTime.iso8601
created
- サーバーの登録日時
41.15. scheduleApplyErrataToActive
- 名前
- scheduleApplyErrataToActive
- 説明
- グループからエラータ更新をアクティブなシステムに適用するアクションをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- string systemGroupName
- array:
- int - errataId
- 戻り値
- array:
- int - actionId
41.16. scheduleApplyErrataToActive
- 名前
- scheduleApplyErrataToActive
- 説明
- 指定した日時にグループからエラータ更新をアクティブなシステムに適用するアクションをスケジュールします。利用可能バージョン: 13.0 以降
- パラメーター
- string sessionKey
- string systemGroupName
- array:
- int - errataId
- dateTime.iso8601 earliestOccurrence
- 戻り値
- array:
- int - actionId
41.17. update
- 名前
- update
- 説明
- 既存するシステムグループを更新します。
- パラメーター
- string sessionKey
- string systemGroupName
- string description
- 戻り値
- struct - Server Group
- int
id
- string
name
- string
description
- int
org_id
- int
system_count
第42章 user.external
概要
IPA 統合を使用して外部の IPA サーバーからのユーザー認証を許可する場合 (まれですが)、ユーザーは Satellite データベースで作成する必要があります。このネームスペースのメソッドを使用すると、作成される組織や付与されるロールなどを設定できるようになります。これらのオプションは、Web 管理インターフェイスでも設定可能です。
42.1. createExternalGroupToRoleMap
- 名前
- createExternalGroupToRoleMap
- 説明
- 外部認証のユーザーは外部グループのメンバーである場合があります。ユーザーのログイン時に、これらのグループを使って新たなロールを割り当てることが可能です。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。一意である必要があります。
- array:
- string - role - 以下のいずれか: satellite_admin, org_admin (implies all other roles except for satellite_admin), channel_admin, config_admin, system_group_admin, activation_key_admin
- 戻り値
- struct - externalGroup
- string
name
- array
roles
- string - role
42.2. createExternalGroupToSystemGroupMap
- 名前
- createExternalGroupToSystemGroupMap
- 説明
- 外部認証のユーザーは外部グループのメンバーである場合があります。ユーザーのログイン時に、これらのグループを使ってユーザーにサーバーグループへのアクセスを付与することが可能です。呼び出しが可能なのは、org_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。一意である必要があります。
- array:
- string - groupName - アクセスを付与する先となるサーバーグループ名
- 戻り値
- struct - externalGroup
- string
name
- array
roles
- string - role
42.3. deleteExternalGroupToRoleMap
- 名前
- deleteExternalGroupToRoleMap
- 説明
- 外部グループのロールマップを削除します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
42.4. deleteExternalGroupToSystemGroupMap
- 名前
- deleteExternalGroupToSystemGroupMap
- 説明
- 外部グループのサーバーグループを削除します。呼び出しが可能なのは、org_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
42.5. getDefaultOrg
- 名前
- getDefaultOrg
- 説明
- orgunit が IPA サーバーで見つからない、または無効になっている場合にユーザーを追加するデフォルト組織を取得します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- 戻り値
- int - デフォルト組織の ID。デフォルトがない場合は 0
42.6. getExternalGroupToRoleMap
- 名前
- getExternalGroupToRoleMap
- 説明
- 外部グループのロールマップの表現を取得します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。
- 戻り値
- struct - externalGroup
- string
name
- array
roles
- string - role
42.7. getExternalGroupToSystemGroupMap
- 名前
- getExternalGroupToSystemGroupMap
- 説明
- 外部グループのサーバーグループマッピングの表現を取得します。呼び出しが可能なのは、org_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。
- 戻り値
- struct - externalGroup
- string
name
- array
roles
- string - role
42.8. getKeepTemporaryRoles
- 名前
- getKeepTemporaryRoles
- 説明
- IPA 以外のメソッドでログインした後でも、IPA のためにユーザーに割り当てられたロールを維持するかどうかを取得します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- 戻り値
- boolean - IPA 以外のメソッドでログインした後でもロールを維持する場合は True。それ以外は false
42.9. getUseOrgUnit
- 名前
- getUseOrgUnit
- 説明
- IPA サーバーで "orgunit" に設定されている組織に対応する組織にユーザーを配置するかどうかを取得します。orgunit の名前は Satellite 組織名と一致する必要があります。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- 戻り値
- boolean - IPA orgunit を使用してユーザーを作成する組織を判定する場合は True。それ以外は false
42.10. listExternalGroupToRoleMaps
- 名前
- listExternalGroupToRoleMaps
- 説明
- すべての既知の外部グループにおけるロールマッピングを一覧表示します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - externalGroup
- string
name
- array
roles
- string - role
42.11. listExternalGroupToSystemGroupMaps
- 名前
- listExternalGroupToSystemGroupMaps
- 説明
- すべての既知の外部グループにおけるサーバーグループマッピングを一覧表示します。呼び出しが可能なのは、org_admin のみです。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - externalGroup
- string
name
- array
roles
- string - role
42.12. setDefaultOrg
- 名前
- setDefaultOrg
- 説明
- orgunit が IPA サーバーで見つからない、または無効になっている場合にユーザーを追加するデフォルト組織を設定します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- int defaultOrg - デフォルト組織として設定する組織の ID。デフォルト組織をなしにする場合は 0
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
42.13. setExternalGroupRoles
- 名前
- setExternalGroupRoles
- 説明
- 外部グループのロールを更新します。ここで設定するロールが以前に設定されたロールを置換します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。
- array:
- string - role - 以下のいずれか: satellite_admin, org_admin (implies all other roles except for satellite_admin), channel_admin, config_admin, system_group_admin, activation_key_admin
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
42.14. setExternalGroupSystemGroups
- 名前
- setExternalGroupSystemGroups
- 説明
- 外部グループのサーバーグループを更新します。ここで設定するサーバーグループが以前に設定されたグループを置換します。呼び出しが可能なのは、org_admin のみです。
- パラメーター
- string sessionKey
- string name - 外部グループの名前。
- array:
- string - groupName - アクセスを付与する先となるサーバーグループ名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
42.15. setKeepTemporaryRoles
- 名前
- setKeepTemporaryRoles
- 説明
- IPA 以外のメソッドでログインした後でも、IPA のためにユーザーに割り当てられたロールを維持するかどうかを設定します。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- boolean keepRoles - IPA 以外のメソッドでログインした後でもロールを維持する場合は True。それ以外は false
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
42.16. setUseOrgUnit
- 名前
- setUseOrgUnit
- 説明
- IPA サーバーで "orgunit" に設定されている組織に対応する組織にユーザーを配置するかどうかを設定します。orgunit の名前は Satellite 組織名と一致する必要があります。呼び出しが可能なのは、satellite_admin のみです。
- パラメーター
- string sessionKey
- boolean useOrgUnit - IPA orgunit を使用してユーザーを作成する組織を判定する場合は True。それ以外は false
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
第43章 user
概要
ユーザーネームスペースには、Web ユーザーインターフェイスから利用可能な一般的なユーザー関数にアクセスするメソッドが含まれます。
43.1. addAssignedSystemGroup
- 名前
- addAssignedSystemGroup
- 説明
- ユーザーの割り当て済みシステムグループにシステムグループを追加します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- string serverGroupName
- boolean setDefault - システムグループをユーザーのデフォルトシステムグループの一覧にも追加するかどうか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.2. addAssignedSystemGroups
- 名前
- addAssignedSystemGroups
- 説明
- ユーザーの割り当て済みシステムグループに複数のシステムグループを追加します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- array:
- string - serverGroupName
- boolean setDefault - 複数のシステムグループをユーザーのデフォルトシステムグループの一覧にも追加するかどうか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.3. addDefaultSystemGroup
- 名前
- addDefaultSystemGroup
- 説明
- ユーザーのデフォルトのシステムグループにシステムグループを追加します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- string serverGroupName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.4. addDefaultSystemGroups
- 名前
- addDefaultSystemGroups
- 説明
- ユーザーのデフォルトシステムグループに複数のシステムグループを追加します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- array:
- string - serverGroupName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.5. addRole
- 名前
- addRole
- 説明
- ロールをユーザーに追加します。
- パラメーター
- string sessionKey
- string login - 更新するユーザーログイン名
- string role - 追加するロールのラベル。以下のいずれか: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.6. create
- 名前
- create
- 説明
- 新規ユーザーを作成します。
- パラメーター
- string sessionKey
- string desiredLogin - 希望するログイン名。既に使用されている場合は、失敗します。
- string desiredPassword
- string firstName
- string lastName
- string email - ユーザーの E メールアドレス
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.7. create
- 名前
- create
- 説明
- 新規ユーザーを作成します。
- パラメーター
- string sessionKey
- string desiredLogin - 希望するログイン名。既に使用されている場合は、失敗します。
- string desiredPassword
- string firstName
- string lastName
- string email - ユーザーの E メールアドレス
- int usePamAuth - このユーザーに PAM 認証を使用する場合は 1、それ以外は 0
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.8. delete
- 名前
- delete
- 説明
- ユーザーを削除します。
- パラメーター
- string sessionKey
- string login - 削除するユーザーログイン名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.9. disable
- 名前
- disable
- 説明
- ユーザーを無効にします。
- パラメーター
- string sessionKey
- string login - 無効にするユーザーログイン名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.10. enable
- 名前
- enable
- 説明
- ユーザーを有効にします。
- パラメーター
- string sessionKey
- string login - 有効にするユーザーログイン名
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.11. getCreateDefaultSystemGroup
- 名前
- getCreateDefaultSystemGroup
- 説明
- CreateDefaultSystemGroup 設定の現行の値を返します。True の場合は、新規ユーザーを作成するたびに (そのユーザーと同じ名前で) システムグループが作成され、ユーザーには自動的にそのグループへのパーミッションが付与されるほか、そのシステムグループがユーザーのデフォルトグループとして設定されます (このため、ユーザーがシステムを登録すると、デフォルトでそのシステムグループに配置されます)。これは、同じ組織内で異なるユーザーが異なるサーバーのグループを管理する際に便利になります。呼び出しができるのは、org_admin のみです。
- パラメーター
- string sessionKey
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.12. getDetails
- 名前
- getDetails
- 説明
- 指定したユーザーについての詳細を返します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- 戻り値
- struct - user details
- string
first_names
- (廃止予定) first_name を使用 - string
first_name
- string
last_name
- string
email
- int
org_id
- string
org_name
- string
prefix
- string
last_login_date
- string
created_date
- boolean
enabled
- ユーザーが有効な場合は true、無効な場合は false - boolean
use_pam
- ユーザーが PAM 認証を使用するように設定されている場合は True - boolean
read_only
- ユーザーが読み取り専用の場合は true - boolean
errata_notification
- ユーザーのエラータ E メール通知が有効になっている場合は true
43.13. getLoggedInTime
- 名前
- getLoggedInTime
- 説明
- ユーザーの最終ログイン時間を返します。廃止予定 - 使用可能な値を返しません。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- 戻り値
- dateTime.iso8601
43.14. listAssignableRoles
- 名前
- listAssignableRoles
- 説明
- このユーザーが他に割り当て可能なユーザーロール一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- string - (role label)
43.15. listAssignedSystemGroups
- 名前
- listAssignedSystemGroups
- 説明
- ユーザーが管理可能なシステムグループを返します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- 戻り値
- array:
- struct - system group
- int
id
- string
name
- string
description
- int
system_count
- int
org_id
- このシステムグループの組織 ID
43.16. listDefaultSystemGroups
- 名前
- listDefaultSystemGroups
- 説明
- ユーザーのデフォルトのシステムグループ一覧を返します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- 戻り値
- array:
- struct - system group
- int
id
- string
name
- string
description
- int
system_count
- int
org_id
- このシステムグループの組織 ID
43.17. listRoles
- 名前
- listRoles
- 説明
- ユーザーのロール一覧を返します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- 戻り値
- array:
- string - (role label)
43.18. listUsers
- 名前
- listUsers
- 説明
- 組織内のユーザー一覧を返します。
- パラメーター
- string sessionKey
- 戻り値
- array:
- struct - user
- int
id
- string
login
- string
login_uc
- ログインの大文字バージョン - boolean
enabled
- ユーザーが有効な場合は true、無効な場合は false
43.19. removeAssignedSystemGroup
- 名前
- removeAssignedSystemGroup
- 説明
- ユーザーの割り当て済みシステムグループからシステムグループを削除します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- string serverGroupName
- boolean setDefault - システムグループをユーザーのデフォルトシステムグループの一覧からも削除するかどうか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.20. removeAssignedSystemGroups
- 名前
- removeAssignedSystemGroups
- 説明
- ユーザーの割り当て済みシステムグループから複数のシステムグループを削除します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- array:
- string - serverGroupName
- boolean setDefault - 複数のシステムグループをユーザーのデフォルトシステムグループの一覧からも削除するかどうか
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.21. removeDefaultSystemGroup
- 名前
- removeDefaultSystemGroup
- 説明
- ユーザーのデフォルトシステムグループからシステムグループを削除します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- string serverGroupName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.22. removeDefaultSystemGroups
- 名前
- removeDefaultSystemGroups
- 説明
- ユーザーのデフォルトシステムグループから複数のシステムグループを削除します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- array:
- string - serverGroupName
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.23. removeRole
- 名前
- removeRole
- 説明
- ユーザーからロールを削除します。
- パラメーター
- string sessionKey
- string login - 更新するユーザーログイン名
- string role - 削除するロールのラベル。以下のいずれか: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.24. setCreateDefaultSystemGroup
- 名前
- setCreateDefaultSystemGroup
- 説明
- CreateDefaultSystemGroup 設定の値を設定します。True の場合は、新規ユーザーを作成するたびに (そのユーザーと同じ名前で) システムグループが作成され、ユーザーには自動的にそのグループへのパーミッションが付与されるほか、そのシステムグループがユーザーのデフォルトグループとして設定されます (このため、ユーザーがシステムを登録すると、デフォルトでそのシステムグループに配置されます)。これは、同じ組織内で異なるユーザーが異なるサーバーのグループを管理する際に便利になります。呼び出しができるのは、org_admin のみです。
- パラメーター
- string sessionKey
- boolean createDefaultSystemGruop - システムグループを自動的に作成する場合は True、それ以外は false
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.25. setDetails
- 名前
- setDetails
- 説明
- ユーザーの詳細を更新します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- struct - user details
- string
first_names
- (廃止予定) first_name を使用 - string
first_name
- string
last_name
- string
email
- string
prefix
- string
password
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.26. setErrataNotifications
- 名前
- setErrataNotifications
- 説明
- 指定したユーザーのエラータ E メール通知を有効、無効にします。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- boolean value - エラータ通知を有効にする場合は True、無効にする場合は False
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.27. setReadOnly
- 名前
- setReadOnly
- 説明
- ターゲットのユーザーが読み取り専用 API アクセスのみを持つか、標準の完全スケールアクセスを持つかを設定します。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- boolean readOnly - ターゲットのユーザーが読み取り専用 API アクセスのみを持つか、標準の完全スケールアクセスを持つかを設定します。
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
43.28. usePamAuthentication
- 名前
- usePamAuthentication
- 説明
- ユーザーが PAM 認証を使用するか、または基本的な Satellite 認証を使用するかを切り替えます。
- パラメーター
- string sessionKey
- string login - ユーザーのログイン名
- int pam_value
- PAM 認証を有効にする場合は 1
- 無効にする場合は 0
- 戻り値
- int - 成功の場合は 1。それ以外は exception thrown
付録A 改訂履歴
改訂履歴 | |||
---|---|---|---|
改訂 1.1-0.1 | Wed Aug 8 2018 | Terry Chuang | |
| |||
改訂 1.1-0 | Wed Feb 1 2017 | Satellite Documentation Team | |
|
法律上の通知
Copyright © 2017 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.