フリート・メンテナンス・イメージとサブスクリプションREST API

ゴールド・イメージは、ベース・ソフトウェア・バージョンと追加パッチに関する情報を含む、最終状態のソフトウェア定義です。最終状態の定義は論理的な用語です。最終状態を表す物理的なソフトウェア・バイナリ・コンポーネントは、ゴールド・イメージと呼ばれます。ゴールド・イメージの詳細は、「標準化アドバイザによる編成」で説明されている標準構成を参照してください。

ソフトウェア・イメージのリストの取得

機能 説明
リクエスト・メソッド GET
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
レスポンス 
{
		"totalResults": 2,
		"items": [
			{
				"name": "RAC1917_a",
				"id": "4B7738536B6E7888E053057FB10ACF8C",
				"description": "RAC191_a",
				"version": "19.17.0",
				"platformName": "Linux x86-64",
				"dateCreated": "2023-03-24 15:09:21.0",
				"owner": "SYSMAN",
				"lastModifiedBy": "SYSMAN"
			},
			{
				"name": "RAC1917_b",
				"id": "4B620EC24DCE61FAE053057FB10AC7D0",
				"description": "RAC191_b",
				"version": "19.17.0",
				"platformName": "Linux x86-64",
				"dateCreated": "2023-03-23 13:16:51.0",
				"owner": "SYSMAN",
				"lastModifiedBy": "SYSMAN"
			}
		]
}

パッチ適用したゴールド・イメージの作成

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
"imageName" : "fm_19c_image1",
"imageDescription" : "fm_19c_image1_description",
"refTargetName":"OraDB19Homesample.subnet.dample.com_7301",
"imageSwLibLocation":"<path>/19.0/linux64",
"refHostCredential" : "SRC_HOST_CREDS:ADMIN",
"refHostRootCred":"SRC_HOST_ROOT_CREDS:ADMIN",
"destHomeLocation":"/ade/<path>/oracle/work/db183rh",
"workingDirectory":"/u01/tmp",
"swLibStorageType":"<OmsShared/NFS>",
"swLibStorageName":"swlib" ,
"nfsLocalMountPoint":"/<path>/nfs"
"versionName":"fm_version1" ,
"patchList":"28828717:600000000071008"
}
レスポンス 
{
	"messages": ["Create Gold Image operation has been submitted successfully with the instance name : 
	'CreateGoldImageProfile_SYSMAN_03_27_2023_10_13_AM' and execution_guid=4BB1192C1A2F2AB3E053057FB10A792E",
	“You can track the status of operation using the following:”, 
	“EMCLI: emcli get_instance_status -exec=4BAFFB4FD4ED1B34E053057FB10A99BF”,
	"Browser:  https://blr123.example.com:111111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4BB1192C1A2F2AB3E053057FB10A792E"
	  ]
}
ペイロードの入力変数の説明
  • imageName: ゴールド・イメージの名前。この名前はイメージ全体で一意である必要があります。
  • imageDescription: イメージの説明。
  • refTargetName: このゴールド・イメージの作成に使用されるOracleホーム・ターゲット。これは、11.2.0.4 PSUおよびすべての個別パッチが適用された既存の環境のデータベースまたはGrid InfrastructureのOracleホームです。参照ターゲット名を見つけるには、Enterprise Managerリポジトリに次の問合せを入力します。
    SELECT  distinct target_name FROM mgmt$target_properties 
WHERE target_name IN (SELECT target_name FROM mgmt_targets 
WHERE target_type='oracle_home'
AND host_name=<Host Name of this Oracle Home>
AND property_name='INSTALL_LOCATION'
AND property_value=<path of Oracle Home>)
  • imageSwLibLocation: ゴールド・イメージのペイロードが格納されるソフトウェア・ライブラリのパス。
  • refHostCredential: これはデータベース・ゴールド・イメージにのみ適用されます。これは<Named Credential: Credential Owner>という形式で入力する必要があります。
  • refHostRootCredential: データベース・ゴールド・イメージにのみ適用されます。これは<Named Credential: Credential Owner>という形式で入力する必要があります。
  • workingDirectory: 参照Oracleホーム・ターゲットのホスト上の一時的な場所。
  • swLibStorageType: ソフトウェア・ライブラリの記憶域タイプ。これには、OMS共有、OMSエージェント・ファイル・システムまたはNFSを指定できます(NFSにする場合は、Enterprise Manager 13.5リリース更新13 [13.5.0.3]以上が必要)。
  • nfsLocalMountPoint: NFSローカル・マウントの絶対パス。このパラメータが指定されていない場合は、かわりにworkingDirectoryの場所がデフォルトとして使用されます。NFSは、Enterprise Managerデプロイメント13.5リリース更新13 (13.5.0.13)以上で使用可能です。このフィールドはNFS記憶域の場合のみ必要であり、OMS記憶域のオプションの場合は必要ありません。
  • swLibStorageName: ソフトウェア・ライブラリの記憶域名。この記憶域名を取得するには、「エンタープライズ」メニューから、「プロビジョニングとパッチ適用」を選択し、「ソフトウェア・ライブラリ」を選択します。「ソフトウェア・ライブラリ」ページで、「アクション」メニューから「管理」を選択します。このページで、「名前」列の値をチェックして、ソフトウェア・ライブラリの記憶域名を取得します。
  • versionName: 1つのイメージは複数のバージョンを持つことができます。デフォルト・バージョンのイメージが作成され、さらにバージョンを追加できます。
  • patchList: ゴールド・イメージに含めるパッチのリスト。

ソフトウェア・イメージの作成

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
	"imageName": "RAC1917_a",
	"imageDescription": "RAC1917_a",
	"refTargetName": "OraDB12Home1_1_example.exampledomain.com_190",
	"imageSwLibLocation": "DB Provisioning/19.17.0/goldimage",
	"refHostCredential": "NC_HOST_2023-03-18-103539:SYSMAN",
	"workingDirectory": "/u01/tmp",
	"swLibStorageType": "<OmsShared/NFS>",
	"swLibStorageName": "swlib",
	"nfsLocalMountPoint":"/<path>/nfs"
	"versionName": "PSUNo"
}
レスポンス 
{
	"messages": ["Create Gold Image operation has been submitted successfully with the instance name : 
	'CreateGoldImageProfile_SYSMAN_03_27_2023_10_13_AM' and execution_guid=4BB1192C1A2F2AB3E053057FB10A792E",
	“You can track the status of operation using the following:”, 
	“EMCLI: emcli get_instance_status -exec=4BAFFB4FD4ED1B34E053057FB10A99BF”,
	"Browser:  https://blr123.example.com:111111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4BB1192C1A2F2AB3E053057FB10A792E"
	  ]
}
ペイロードの入力変数の説明
  • imageName: ゴールド・イメージの名前。この名前はイメージ全体で一意である必要があります。
  • imageDescription: イメージの説明。
  • refTargetName: このゴールド・イメージの作成に使用されるOracleホーム・ターゲット。これは、11.2.0.4 PSUおよびすべての個別パッチが適用された既存の環境のデータベースまたはGrid InfrastructureのOracleホームです。参照ターゲット名を見つけるには、Enterprise Managerリポジトリに次の問合せを入力します。
    SELECT  distinct target_name FROM mgmt$target_properties 
WHERE target_name IN (SELECT target_name FROM mgmt_targets 
WHERE target_type='oracle_home'
AND host_name=<Host Name of this Oracle Home>
AND property_name='INSTALL_LOCATION'
AND property_value=<path of Oracle Home>)
  • imageSwLibLocation: ゴールド・イメージのペイロードが格納されるソフトウェア・ライブラリのパス。
  • refHostCredential: これはデータベース・ゴールド・イメージにのみ適用されます。これは<Named Credential: Credential Owner>という形式で入力する必要があります。
  • workingDirectory: 参照Oracleホーム・ターゲットのホスト上の一時的な場所。
  • swLibStorageType: ソフトウェア・ライブラリの記憶域タイプ。OMS共有またはOMSエージェント・ファイル・システムを指定できます。
  • swLibStorageName: ソフトウェア・ライブラリの記憶域名。この記憶域名を取得するには、「エンタープライズ」メニューから、「プロビジョニングとパッチ適用」を選択し、「ソフトウェア・ライブラリ」を選択します。「ソフトウェア・ライブラリ」ページで、「アクション」メニューから「管理」を選択します。このページで、「名前」列の値をチェックして、ソフトウェア・ライブラリの記憶域名を取得します。
  • nfsLocalMountPoint: NFSローカル・マウントの絶対パス。このパラメータが指定されていない場合は、かわりにworkingDirectoryの場所がデフォルトとして使用されます。NFSは、Enterprise Managerデプロイメント13.5リリース更新13 (13.5.0.13)以上で使用可能です。このフィールドはNFS記憶域の場合のみ必要であり、OMS記憶域のオプションの場合は必要ありません。
  • versionName: 1つのイメージは複数のバージョンを持つことができます。デフォルト・バージョンのイメージが作成され、さらにバージョンを追加できます。

ソフトウェア・イメージのエクスポート

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/exportsoftwareimage
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
ペイロード 
{
	"imageId":"C672F6FC600B2484E0532D8145648320",
	"destHostName":"racdbexample.sample.com",
	"destHostCred":"CUSER:SYSMAN",
	"goldImageBundleLocation":"/scratch/cuser/Goldimage/exportedImage",
	"goldImageBundleName":"ExportGoldImage.zip"
}
レスポンス 
Export Gold Image operation has been submitted successfully with the instance name : 
'ExportSoftwareImage_SYSMAN_08_03_2023_11_11_AM' and execution_guid='C89D73FD58D949D5E0532D814564D35C'
You can track the status of operation using the following:Browser: 
https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C89D73FD58D949D5E0532D814564D35C

ペイロードの入力変数の説明

  • imageName: ゴールド・イメージの名前。この名前はイメージ全体で一意である必要があります。
  • destHostName: 宛先ホストの名前。
  • destHostCredential: 使用する宛先ホスト資格証明。これは<Named Credential: Credential Owner>という形式で入力する必要があります。
  • goldImageBundleLocation: ゴールド・イメージ・バンドルの場所。この場所はEnterprise Managerで検出され、使用可能になっている必要があります。NFSをエクスポート操作とインポート操作に使用できます。NFSの場所のパスを入力します。
  • goldImageBundleName: ゴールド・イメージ・バンドルのZipファイル名。

ソフトウェア・イメージのインポート

機能 説明
リクエスト・メソッド POST
URI 
https://<OMS_CONSOLE_HOST:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/importsoftwareimage
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
	"imageName":"21c patched image - imported",
	"hostName":"dbexample21c.domain.example.com",
	"hostCred":"CUSER:SYSMAN",
	"goldImageBundleLocation":"/scratch/cuser/Goldimage/exportedImage",
	"goldImageBundleName":"ExportGoldImage.zip",
	"imageDescription":"21c patched imported image",
	"imageSwLibLocation":"Database Provisioning Profiles/21.0.0.0/linux.x64",
	"swLibStorageType":"<OmsShared/NFS>",
	"swLibStorageName":"swlib",
	"nfsLocalMountPoint":"/<path>/nfs"
	"versionName":"21c patched image"
}
レスポンス 
Import Gold Image operation has been submitted successfully with the instance name : 'ImportSoftwareImage_SYSMAN_08_03_2021_17_26_PM' and execution_guid='C8A6F40E654A7809E0532D814564D0EB'
You can track the status of operation using the following:
Browser: https://<OMS_CONSOLE_HOST:OMS_CONSOLE_PORT>/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C8A6F40E654A7809E0532D814564D0EB

ペイロードの入力変数の説明

  • imageName: ゴールド・イメージの名前。この名前はイメージ全体で一意である必要があります。

    ノート:

    インポート・ソフトウェア・イメージREST APIには、パラメータのimageNameまたはimageIdを指定できます。imageIdを指定すると、指定したimageIdの新しいバージョンがインポートされます。
  • imageDescription: イメージの説明。
  • hostName: ホストの名前。
  • hostCredential: 使用するホスト資格証明。これは<Named Credential: Credential Owner>という形式で入力する必要があります。
  • goldImageBundleLocation: ゴールド・イメージ・バンドルの場所。この場所はEnterprise Managerで検出され、使用可能になっている必要があります。
  • goldImageBundleName: ゴールド・イメージ・バンドルのZipファイル名。
  • imageSwLibLocation: ゴールド・イメージのペイロードが格納されるソフトウェア・ライブラリのパス。
  • workingDirectory: 参照Oracleホーム・ターゲットのホスト上の一時的な場所。
  • swLibStorageType: ソフトウェア・ライブラリの記憶域タイプ。これには、OMS共有、OMSエージェント・ファイル・システムまたはNFSを指定できます(NFSにする場合は、Oracle Enterprise Manager 13.5リリース更新13 [13.5.0.13]以上が必要)。
  • swLibStorageName: ソフトウェア・ライブラリの記憶域名。この記憶域名を取得するには、「エンタープライズ」メニューから、「プロビジョニングとパッチ適用」を選択し、「ソフトウェア・ライブラリ」を選択します。「ソフトウェア・ライブラリ」ページで、「アクション」メニューから「管理」を選択します。このページで、「名前」列の値をチェックして、ソフトウェア・ライブラリの記憶域名を取得します。
  • nfsLocalMountPoint: NFSローカル・マウントの絶対パス。このパラメータが指定されていない場合は、かわりにworkingDirectoryの場所がデフォルトとして使用されます。NFSは、Enterprise Managerデプロイメント13.5リリース更新13 (13.5.0.13)以上で使用可能です。このフィールドはNFS記憶域の場合のみ必要であり、OMS記憶域のオプションの場合は必要ありません。
  • versionName: 1つのイメージは複数のバージョンを持つことができます。デフォルト・バージョンのイメージが作成され、さらにバージョンを追加できます。

ソフトウェア・イメージの適用性のチェック

機能 説明
リクエスト・メソッド POST
URI 
https://<OMS_CONSOLE_HOST:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/checkapplicability
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
"imageId":"C672F6FC600B2484E0532D8145648320",
"targetList":"exampledb21c.domain.example.com",
"targetType":"oracle_database"
}
レスポンス 
{
"applicableStatus": "Image is applicable. More Information: Image have 96 additional bugs fixed.",
"totalBugs": 96,
"bugList": [{
"bugNum": "19134173",
"patchId": "20082080",
"bugDesc": "ORA-600 [KGHFRF NXT] DURING STRESS TESTS"
}, {
"bugNum": "19309466",
"patchId": "20082080",
"bugDesc": "Fix for Bug 19309466"
}, {
"bugNum": "19518079",
"patchId": "20082080",
"bugDesc": "DBA_REGISTRY_HISTORY IS NOT UPDATED DURING UPGRADE TO 12.1.0.2"
}, {
"bugNum": "19189525",
"patchId": "20082079",
"bugDesc": "ENHANCE SQLPATCH BOOTSTRAPPING CODE"
},
----
----
{
"bugNum": "19382851",
"patchId": "20082080",
"bugDesc": "ORA-1031 DURING MVIEW CREATION/REFRESH"
}],
"totalPatches": 0,
"patchList": []
}

ペイロードの入力変数の説明

  • imageName: ゴールド・イメージの名前。この名前はイメージ全体で一意である必要があります。
  • targetList: ターゲットの名前
  • targetType: エンティティ・タイプに基づくCLIコマンド入力の表を参照してください。

ソフトウェア・イメージの検索

検索は、問合せパラメータとして様々な入力を使用してフィルタできます。使用可能な問合せパラメータは、次のとおりです。
  • name
  • version
  • description
  • owner
  • target _type
次に、問合せパラメータNameを使用した例を示します。
機能 説明
リクエスト・メソッド GET
URI 
https://<OMS_CONSOLE_HOST:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages/search?name=%RAC%_a
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
レスポンス 
{
	"totalResults": 1,
	"items": [
		{
			"name": "RAC1917_a",
			"id": "4B7738536B6E7888E053057FB10ACF8C",
			"description": "RAC1917",
			"version": "19.17.0",
			"platformName": "Linux x86-64",
			"dateCreated": "2023-03-24 15:09:21.0",
			"owner": "SYSMAN",
			"lastModifiedBy": "SYSMAN"
		}
	]
}

ソフトウェア・イメージの削除

機能 説明
リクエスト・メソッド DELETE
URI 
https://<OMS_CONSOLE_HOST:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages>
または
https://</a><OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages?image_id=<image id>
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード

ノート:

URIでimage_idを渡す場合、ペイロードimage_idは不要です。 
{
	"image_id" : "4B7738536B6E7888E053057FB10ACF8C"
)
レスポンス 
{
		"messages" : "Image with id=4B7738536B6E7888E053057FB10ACF8C  deleted successfully"
}

ペイロードの入力変数の説明

  • image_id: イメージのGUID。

選択したイメージへのターゲットのサブスクライブ

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/imagesubscriptions
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード
単一のターゲット・エントリの場合:
{
	"imageId" : "<image id>",
	"targetName" : "<Examplerep_Database>",
	"targetType" : "<example_database>"
}
単一ターゲット・エントリの場合:
{
	"imageId" : "<image id>",
	"targetList" : "<targetname1,targetname2>",
	"targetType" : "<target type>",
	"standbyAutoSubscribe" : "true",
	"noCascade": "true",
	"gimr" : "true"
}
レスポンス 
{
	"messages": [
		"Target 'Examplerep_Database' subscribed successfully."
	]
}
ペイロードの入力変数の説明
  • imageId: イメージのGUID。
  • targetType: このイメージにサブスクライブされるターゲットのターゲット・タイプ。
  • targetName: ターゲットの名前。
  • targetList: サブスクライブするターゲットの名前リスト。
  • standbyAutoSubscribe: falseに設定すると、スタンバイ・データベースは自動的にサブスクライブされなくなります。デフォルト値はtrueです。
  • noCascade: trueに設定すると、CDBのPDBはイメージにサブスクライブされなくなります。
  • gimr: trueに設定すると、クラスタのGIMRはイメージにサブスクライブされます。デフォルト値はfalse

イメージのサブスクリプションのリスト

機能 説明
リクエスト・メソッド GET
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/imagesubscriptions?image_id=<image_id>https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages"
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
レスポンス 
{
  "totalResults": 5,
  "items": [{
    "imageId": "D572786F3CE031C9E0532D81456415BC",
    "targetGuid": "01DB50F6963F0E39C72F8651DCC93A6A",
    "parentGuid": "DCDC55D15C2B413772E442DA6D6CCE70",
    "dateSubscribed": "2022-01-13 15:52:28.0"
  }, {
    "imageId": "D572786F3CE031C9E0532D81456415BC",
    "targetGuid": "6A23FD99A8B6A7780AE930377D6B53D0",
    "dateSubscribed": "2022-02-03 17:09:11.0"
  }, {
    "imageId": "D572786F3CE031C9E0532D81456415BC",
    "targetGuid": "7E6BEB235D6653F9E03C1C9EC4C2560B",
    "parentGuid": "DCDC55D15C2B413772E442DA6D6CCE70",
    "dateSubscribed": "2022-01-13 15:52:28.0"
  }, {
    "imageId": "D572786F3CE031C9E0532D81456415BC",
    "targetGuid": "B2C9231A5BEAC5B6C58EA6A75A8962B6",
    "parentGuid": "DCDC55D15C2B413772E442DA6D6CCE70",
    "dateSubscribed": "2022-01-13 15:52:28.0"
  }, {
    "imageId": "D572786F3CE031C9E0532D81456415BC",
    "targetGuid": "DCDC55D15C2B413772E442DA6D6CCE70",
    "dateSubscribed": "2022-01-13 15:52:28.0"
  }]
}
ペイロードの入力変数の説明
  • imageId: イメージのGUID。
  • targetGuid: ターゲットGUID。
  • dateSubscribed: サブスクリプションの日付。"YEAR-MM-DD HH:MM:SS.MS"の書式で入力する必要があります

選択したイメージからのターゲットのサブスクライブ解除

機能 説明
リクエスト・メソッド DELETE
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/imagesubscriptions
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
	"imageId" : "4B620EC24DCE61FAE053057FB10AC7D0",
	"targetName" : "Examplerep_Database",
	"targetType" : "example_database",
	"noCascade" : "true",
}
レスポンス 
{
	"messages": [
		"Target 'Examplerep_Database' unsubscribed successfully."
	]
}
ペイロードの入力変数の説明
  • imageId: イメージのGUID。
  • targetType: このイメージからサブスクライブ解除されるターゲットのターゲット・タイプ。
  • targetName: ターゲットの名前。
  • noCascade: trueに設定すると、CDBのPDBはイメージにサブスクライブされなくなります。

イメージのターゲット・サブスクリプションのリスト

機能 説明
リクエスト・メソッド PUT
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/targetsubscriptions
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
	"targetName" : "Examplerep_Database",
	"targetType" : "example_database"
}
レスポンス 
{
	"totalResults": 1,
	"items": [
		{
			"targetName": "Examplerep_Database",
			"targetType": "example_database",
			"imageId": "4B7738536B6E7888E053057FB10ACF8C",
			"imageName": "RAC121_a",
			"subscriptionDate": "2017-03-27 10:06:00.0"
		}
	]
}
ペイロードの入力変数の説明
  • targetType: ターゲットのターゲット・タイプ。
  • targetName: ターゲットの名前。

イメージのバージョンの作成

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/softwareimages"
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
	"imageId": " 4B7738536B6E7888E053057FB10ACF8C",
	"refTargetName": "OraDB12Home1_1_slc06nag.example.com_190",
	"imageSwLibLocation": "DB Provisioning/12.1.0.2.0/goldimage",
	"refHostCredential": "NC_HOST_2017-03-18-103539:SYSMAN",
	"workingDirectory": "/tmp",
	"swLibStorageType": "OmsShared",
	"swLibStorageName": "swlib",
	"versionName": "PSUNo"
}
レスポンス 
{
	"messages": ["Create Gold Image operation has been submitted successfully with the instance name :
	'CreateGoldImageProfile_SYSMAN_03_27_2017_10_13_AM' and execution_guid=4BB1192C1A2F2AB3E053057FB10A792E",
	“You can track the status of operation using the following:”,
	“EMCLI: emcli get_instance_status -exec=4BAFFB4FD4ED1B34E053057FB10A99BF”,
		"Browser:  https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4BB1192C1A2F2AB3E053057FB10A792E"
			]
}
ペイロードの入力パラメータの説明
  • imageId: イメージのGUID。
  • refTargetName: このゴールド・イメージの作成に使用されるOracleホーム・ターゲット。これは、11.2.0.4 PSUおよびすべての個別パッチが適用された既存の環境のデータベースまたはGrid InfrastructureのOracleホームです。参照ターゲット名を見つけるには、Enterprise Managerリポジトリに次の問合せを入力します。
    SELECT  distinct target_name FROM mgmt$target_properties
WHERE target_name IN (SELECT target_name FROM mgmt_targets 
WHERE target_type='oracle_home'
AND host_name=<Host Name of this Oracle Home>
AND property_name='INSTALL_LOCATION'
AND property_value=<path of Oracle Home>)
  • imageSwLibLocation: ゴールド・イメージのペイロードが格納されるソフトウェア・ライブラリのパス。
  • refHostCredential: これはデータベース・ゴールド・イメージにのみ適用されます。これは<Named Credential: Credential Owner>という形式で入力する必要があります。
  • workingDirectory: 参照Oracleホーム・ターゲットのホスト上の一時的な場所。
  • swLibStorageType: ソフトウェア・ライブラリの記憶域タイプ。OMS共有またはOMSエージェント・ファイル・システムを指定できます。
  • swLibStorageName: ソフトウェア・ライブラリの記憶域名。この記憶域名を取得するには、「エンタープライズ」メニューから、「プロビジョニングとパッチ適用」を選択し、「ソフトウェア・ライブラリ」を選択します。「ソフトウェア・ライブラリ」ページで、「アクション」メニューから「管理」を選択します。このページで、「名前」列の値をチェックして、ソフトウェア・ライブラリの記憶域名を取得します。
  • versionName: 1つのイメージは複数のバージョンを持つことができます。デフォルト・バージョンのイメージが作成され、さらにバージョンを追加できます。

バージョンのリスト

機能 説明
リクエスト・メソッド GET
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/versions?image_id=4B7738536B6E7888E053057FB10ACF8C
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
レスポンス 
{
	"totalResults": 1,
	"items": [
		{
			"name": "PSUNos",
			"versionId": "4BAFA861A7ED6603E053057FB10A0588",
			"imageId": "4B7738536B6E7888E053057FB10ACF8C",
			"externalId": "oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1",
			"status": "CURRENT",
			"position": "1",
			"hashCode": "C1622270664:B<NO_PATCHES>",
			"dateCreated": "2017-03-27 10:13:28.0",
			"provisioningStatus": "READY"
		}
	]
}

推奨パッチ

機能 説明
リクエスト・メソッド GET
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/E0D780B614811C8FE05334814564FF08/patchRecommendations
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
レスポンス 
{
    "messages": {
        "uploadPatches": "To upload recommended patches in EM use the following command: emcli upload_patches -from_host='host_name' -patch_files='metadata_file_path;ZIP_file_path' [-cred_name='name' -cred_owner='owner']. In online connection mode, the patches can be directly downloaded to EM as well.",
        "createNewVersion": "To create a new version of the image with the recommended patches see: https://www.oracle.com/pls/topic/lookup?ctx=en/enterprise-manager&id=EMLCM-GUID-431C8AE4-774B-4DD8-89A5-A6A30B071740"
    },
    "totalRecommendedPatches": 7,
    "recommendedPatches": "[33881712,32579178,33803476,33806152,30133696,33808367,33881715]",
    "recommendedPatchesDetails": [
        {
            "patchId": "33881712",
            "patchDescription": "QUARTERLY FULL STACK DOWNLOAD PATCH FOR EXADATA (APR2022 - 19.15)"
        },
        {
            "patchId": "32579178",
            "patchDescription": "QUARTERLY FULL STACK DOWNLOAD PATCH FOR EXADATA (APR2021 - 19.11)"
        },
        {
            "patchId": "33803476",
            "patchDescription": "GI RELEASE UPDATE 19.15.0.0.0"
        },
        {
            "patchId": "33806152",
            "patchDescription": "DATABASE RELEASE UPDATE 19.15.0.0.0"
        },
        {
            "patchId": "30133696",
            "patchDescription": "QUARTERLY FULL STACK DOWNLOAD PATCH FOR EXADATA (OCT2019 - 19.5)"
        },
        {
            "patchId": "33808367",
            "patchDescription": "OJVM RELEASE UPDATE 19.15.0.0.0"
        },
        {
            "patchId": "33881715",
            "patchDescription": "QUARTERLY FULL STACK DOWNLOAD PATCH FOR EXADATA (APR2022 - 21.6)"
        }
    ]
}

ノート:

パッチ推奨にバグ・リストを含める場合は、URIの末尾に?include=bugsを追加します。

イメージの説明

機能 説明
リクエスト・メソッド POST
URI /em/websvcs/restful/emws/db/goldimage/describeimage
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
"imageId":"C672F6FC600B2484E0532D8145648320",
"bugs":"true"
}
レスポンス 
{
  "totalBugs": 96,
  "bugList": [{
    "bugNum": "19134173",
    "patchId": "20082080",
    "patchUpi": "",
    "bugDesc": "ORA-600 [KGHFRF NXT] DURING STRESS TESTS"
  }, {
    "bugNum": "19309466",
    "patchId": "20082080",
    "patchUpi": "",
    "bugDesc": "Fix for Bug 19309466"
  }, {
    "bugNum": "19518079",
    "patchId": "20082080",
    "patchUpi": "",
    "bugDesc": "DBA_REGISTRY_HISTORY IS NOT UPDATED DURING UPGRADE TO 12.1.0.2"
  },
…
…
…
{
    "bugNum": "19382851",
    "patchId": "20082080",
    "patchUpi": "",
    "bugDesc": "ORA-1031 DURING MVIEW CREATION/REFRESH"
  }],
  "totalPatches": 4,
  "patchList": [{
    "patchId": "20140673",
    "patchDesc": "OCW Interim patch for 20140673"
  }, {
    "patchId": "20119232",
    "patchDesc": "Database Release Update 21.0.0.0.0"
  }, {
    "patchId": "20082080",
    "patchDesc": "Database Release Update 21.0.0.0.0.2 (20082080)"
  }, {
    "patchId": "20082079",
    "patchDesc": "Database Release Update 21.0.0.0.0.1 (20082079)"
  }]
}
ペイロードの入力パラメータの説明
  • imageId: イメージのGUID。
  • bugs: オプションのパラメータ。デフォルト値はfalseです。bugsがfalseに設定されていると、パッチ情報のみが表示されます。

バージョン・ステータスの更新

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/updateversionstatus
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
	"versionId":"C8A75F54F77332F9E0532D814564757A",
	"versionStatus":"ACTIVE"
}
レスポンス 
Version ID 'C8A75F54F77332F9E0532D814564757A' updated successfully.
ペイロードの入力変数の説明
  • versionId: バージョンのGUID。
  • versionStatus: 更新中にステータスを「ACTIVE」に設定します。

バージョンの削除

機能 説明
リクエスト・メソッド DELETE
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/versions
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
ペイロード 
{
"versionId": "4BB099D42CC8671EE053057FB10A07DA"
}
レスポンス 
{
	"messages": [
		"The following version will be deleted. 4BB099D42CC8671EE053057FB10A07DA"
		]
}
ペイロードの入力変数の説明
  • versionId: バージョンのGUID。

リスナーの移行

機能 説明
リクエスト・メソッド POST
URI

/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/migratelistener
リクエスト・ヘッダー Authorization: basic <generated credential value>

Content-Type: application/json
ペイロード 
{
"name" : "migrate_listener",
"description":"Migrate_listener",
"targetName" : “DB1",
"targetType":"oracle_database",
"normalCredString":"$NORMAL_CRED",
"privCredString": "$PRIV_CRED"
}
レスポンス 
Processing target: blr123.example.com
Checking if target is already running from the current version of the image...
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Migrate Listener' created successfully.
Listener migration for blr123.example.com can be monitored using
Browser:
  https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C9A8D4E023052089E0532D8145641564
Status:Success
ペイロードの入力変数の説明
  • name: 操作名(migrate_listener)。
  • description: 操作の説明
  • targetName: ターゲット・データベース名
  • targetType: ターゲット・タイプのEM CLIリストを参照してください。
  • normalCredString: 使用する通常資格証明。
  • privCredString: 使用する特権資格証明。

リスナーのロールバック

機能 説明
リクエスト・メソッド POST
URI

/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/rollbacklistener
リクエスト・ヘッダー Authorization: basic <generated credential value>

Content-Type: application/json
ペイロード 
{
"name" : "rollback_listener",
"description":"Migrate_rollback_listener",
"targetName" : “DB1",
"targetType":"oracle_database",
"normalCredString":"$NORMAL_CRED",
"privCredString": "$PRIV_CRED"
}
レスポンス 
Processing target: blr123.example.com
Checking if target is already running from the current version of the image...
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Rollback Listener' created successfully.
Listener rollback for blr123.example.com can be monitored using
Browser:
  https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C9A8D4E023052089E0532D8145641564
Status:Success
ペイロードの入力変数の説明
  • name: 操作名(rollback_listener)。
  • description: 操作の説明
  • targetName: ターゲット・データベース名
  • targetType: ターゲット・タイプのEM CLIリストを参照してください。
  • normalCredString: 使用する通常資格証明。
  • privCredString: 使用する特権資格証明。