-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
54 changed files
with
4,139 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# ontap-automation |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: accessing_the_ontap_cli_through_the_rest_api.html | ||
keywords: | ||
summary: | ||
--- | ||
= REST API を使用した ONTAP CLI へのアクセス | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
CLI および ONTAPI API から ONTAP REST API に移行するユーザ向けに、 ONTAP には CLI にアクセスするための REST エンドポイントが用意されています。このパススルー機能を使用して、任意の CLI コマンドを実行できます。REST エンドポイントの使用状況は、 REST API のギャップを特定して以降のリリースで改善できるように、ネットアップに AutoSupport のデータで返されます。 | ||
|
||
CLI コマンドを問題に送信するには、以下に関するルールに基づいた適切な形式で REST API 呼び出しを実行する必要があります。 | ||
|
||
* リソースパス | ||
* フィールド名 | ||
* HTTP メソッド | ||
|
||
|
||
CLI アクセスの基本リソース・パスは '/private/cli' ですREST API を使用した CLI へのアクセスの詳細については、 ONTAP API オンラインドキュメントページを参照してください。 | ||
|
||
|
||
NOTE: ネットアップでは、コードサンプルやその他の有用な情報を格納する GitHub リポジトリを用意しています。CLI パススルーファシリティの使用例については、リポジトリにアクセスしてください。 | ||
|
||
https://github.com/NetApp/ontap-rest-python/tree/master/examples/rest_api/cli_passthrough_samples["ONTAP REST Python GitHub リポジトリ - CLI パススルーサンプル"^] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: additional_considerations_when_using_the_rest_api.html | ||
keywords: | ||
summary: | ||
--- | ||
= REST API を使用する場合のその他の考慮事項を次に示します | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
ONTAP REST API には、その操作や使用に影響するいくつかの特性があります。API 呼び出しを発行する前に、それらの考慮事項を確認しておく必要があります。 | ||
|
||
API を通じて公開されているリソースを確認してください。 | ||
|
||
link:summary_of_the_rest_resource_categories.html["REST リソースカテゴリの概要"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: api_reference.html | ||
keywords: | ||
summary: | ||
--- | ||
= API リファレンス | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
HTTP メソッド、入力パラメータ、応答など、すべての ONTAP REST API 呼び出しの詳細にアクセスできます。このリファレンスは、 REST API を使用して自動化アプリケーションを開発する場合に役立ちます。 | ||
|
||
|
||
NOTE: API リファレンスコンテンツには、ローカルの ONTAP システムまたはネットアップ開発者ネットワークの Web サイトからアクセスできます。 | ||
|
||
|
||
|
||
== ONTAP API ドキュメントページへのアクセス | ||
|
||
[role="lead"] | ||
ONTAP API オンラインドキュメントページは、ローカルの ONTAP システムからアクセスできます。 | ||
|
||
次の情報が必要です。 | ||
|
||
* ONTAP クラスタ管理 LIF の IP アドレスまたはホスト名 | ||
* ONTAP REST API にアクセスする権限を持つアカウントのユーザ名とパスワード | ||
|
||
|
||
.手順 | ||
. ブラウザに URL を入力し、 *Enter* キーを押します。 | ||
+ | ||
https://<ip_address>/docs/api` | ||
|
||
. ONTAP アカウントを使用してサインインします。 | ||
+ | ||
ONTAP API ドキュメントページが表示され、主要なリソースカテゴリ別に分類された API 呼び出しが下部に表示されます。 | ||
|
||
. 個々の API 呼び出しの例として、 * cluster * カテゴリまでスクロールし、 * get/cluster * をクリックします。 | ||
|
||
|
||
|
||
|
||
== NetApp DevNet でリファレンスコンテンツにアクセスする | ||
|
||
[role="lead"] | ||
ONTAP REST API リファレンスドキュメントは、ネットアップ開発者ネットワークの Web サイトから入手できます。 | ||
|
||
.手順 | ||
. ネットアップ開発者ネットワークの Web サイトで「 ONTAP REST API * 」ページに移動します。 | ||
+ | ||
https://devnet.netapp.com/restapi.php["ネットアップの DevNet : ONTAP REST API"^] | ||
|
||
. 下にスクロールし、 * オンライン REST API リファレンス * で該当する ONTAP バージョンのリンクをクリックします。 | ||
+ | ||
ONTAP API ドキュメントページが表示され、主要なリソースカテゴリ別に分類された API 呼び出しが下部に表示されます。 | ||
|
||
. 個々の API 呼び出しの例として、 * cluster * カテゴリまでスクロールし、 * get/cluster * をクリックします。 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: application.html | ||
keywords: | ||
summary: | ||
--- | ||
= アプリケーション | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
ONTAP アプリケーションリソースの管理に使用できる API 呼び出しを次に示します。 | ||
|
||
|
||
|
||
==== アプリケーション | ||
|
||
ONTAP アプリケーションは、テンプレート、アプリケーション、コンポーネント、 Snapshot コピーなどのタイプに基づいて分類されます。このリソースタイプは ONTAP 9.6 で導入されました。 | ||
|
||
|
||
|
||
==== アプリケーションのスナップショット | ||
|
||
アプリケーションの Snapshot コピーがサポートされます。 Snapshot コピーはいつでも作成またはリストアできます。このリソースタイプは ONTAP 9.6 で導入されました。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: basic_operational_characteristics.html | ||
keywords: | ||
summary: | ||
--- | ||
= 基本的な動作特性 | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
REST で共通のテクノロジとベストプラクティスは確立されますが、各 API の詳細は設計内容に応じて異なる場合があります。 | ||
|
||
|
||
|
||
=== 要求と応答の API トランザクション | ||
|
||
すべての REST API 呼び出しは、 ONTAP システムへの HTTP 要求として実行され、クライアントへの関連する応答が生成されます。この要求と応答のペアで API トランザクションが構成されます。API を使用する前に、要求の制御に使用できる入力変数と応答出力の内容を理解しておく必要があります。 | ||
|
||
|
||
|
||
=== CRUD 操作のサポート | ||
|
||
ONTAP REST API で使用できる各リソースへのアクセスは CRUD モデルに基づきます。 | ||
|
||
* 作成 | ||
* 読み取り | ||
* 更新 | ||
* 削除 | ||
|
||
|
||
一部のリソースでは、一部の処理のみがサポートされます。各リソースの詳細については、 ONTAP クラスタで ONTAP API ドキュメントページを参照してください。 | ||
|
||
|
||
|
||
=== オブジェクト ID | ||
|
||
各リソースインスタンスまたはオブジェクトには、作成時に一意の識別子が割り当てられます。ほとんどの場合、識別子は 128 ビットの UUID です。これらの識別子は、特定の ONTAP クラスタ内でグローバルに一意です。新しいオブジェクトインスタンスを作成する API 呼び出しを実行すると、関連付けられた ID の値を含む URL が HTTP 応答の場所ヘッダーにある呼び出し元に返されます。リソースインスタンスを以降の呼び出しで参照する際には、この識別子を抽出して使用できます。 | ||
|
||
|
||
IMPORTANT: オブジェクト識別子の内容と内部構造は、いつでも変更される可能性があります。識別子を使用するのは、該当する API 呼び出しで関連付けられているオブジェクトを参照するときに必要に応じてのみです。 | ||
|
||
|
||
|
||
=== オブジェクトのインスタンスとコレクション | ||
|
||
リソースパスと HTTP メソッドに応じて、 API 呼び出しを特定のオブジェクトインスタンスまたはオブジェクトのコレクションに適用できます。 | ||
|
||
|
||
|
||
=== 同期操作と非同期操作 | ||
|
||
ONTAP では、クライアントから受信した HTTP 要求を 2 つの方法で実行します。 | ||
|
||
同期処理:: | ||
+ | ||
-- | ||
GET 、 HEAD 、 OPTIONS の各メソッドを使用する要求は、いずれも常に同期的に実行されます。また、 POST 、 PATCH 、 DELETE を使用する要求は、完了までに 2 秒かからないと予想される場合は同期的に実行するように設計されています。 | ||
|
||
-- | ||
非同期処理:: | ||
+ | ||
-- | ||
POST 、 PATCH 、 DELETE の各メソッドを使用する要求は、完了までに 2 秒以上かかると予想される場合は非同期で実行するように設計されています。 | ||
|
||
|
||
NOTE: 「 return _timeout 」クエリパラメータは、非同期 API 呼び出しで使用でき、非同期呼び出しを同期的に完了するように変換できます。詳細については ' ジョブオブジェクトを使用した非同期処理の動作を参照してください | ||
|
||
-- | ||
|
||
|
||
|
||
|
||
=== セキュリティ | ||
|
||
REST API のセキュリティは、主に ONTAP で利用可能な既存のセキュリティ機能に基づいています。API で使用されるセキュリティは次のとおりです。 | ||
|
||
* トランスポートレイヤのセキュリティ | ||
+ | ||
ONTAP LIF とクライアントの間でネットワークを介して送信されるトラフィックは、通常、 ONTAP の設定に基づいて TLS を使用してすべて暗号化されます。 | ||
|
||
* クライアント認証 | ||
+ | ||
ONTAP System Manager および Network Manageability SDK と同じ認証オプションを ONTAP REST API でも使用できます。 | ||
|
||
* HTTP 認証 | ||
+ | ||
HTTP レベルでは、 API トランザクションにベーシック認証が使用されます。base64 文字列のユーザ名とパスワードを含む HTTP ヘッダーが各要求に追加されます。 | ||
|
||
* ONTAP 許可 | ||
+ | ||
ONTAP では、ロールベースの認証モデルが実装されています。ONTAP REST API または API ドキュメントページにアクセスするときは、適切な権限を持つアカウントを使用する必要があります。 | ||
|
||
|
||
|
||
link:security_using_rbac.html["RBAC を使用したセキュリティ"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: blogs.html | ||
keywords: | ||
summary: | ||
--- | ||
= ONTAP の自動化に関するブログです | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
ONTAP 自動化のさまざまなテクノロジやアプローチについて理解を深めるのに役立つブログ記事がいくつかあります。 | ||
|
||
|
||
|
||
===== ONTAPI から REST へのマッピング | ||
|
||
ネットアップでは、独自の ONTAPI (旧 Zephyr ) API からより堅牢な新しい ONTAP REST API への移行をサポートしています。 | ||
|
||
https://netapp.io/2020/12/17/ontapi-to-rest-mapping/["netapp.io/204/12/17/ontapi-rest-mapping"^] | ||
|
||
|
||
|
||
===== ONTAP REST API でプライベート CLI パススルーを使用する | ||
|
||
CLI パススルーは、 REST API を使用して ONTAP CLI コマンドを実行するための技術です。 | ||
|
||
https://netapp.io/2020/11/09/private-cli-passthrough-ontap-rest-api/["netapp.io/2020/09/11/private-cli-passthrough-ONTAP-rest-API"^] | ||
|
||
|
||
|
||
===== ネットアップと Ansible の使用: Ansible のインストール | ||
|
||
Ansible for ONTAP 自動化を初めて使用する方には、この作業を始めることをお勧めします。 | ||
|
||
https://netapp.io/2018/10/08/getting-started-with-netapp-and-ansible-install-ansible["netapp.io/2018/08/geting-started-with -NetApp-and - Ansible install-Ansible"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar: sidebar | ||
permalink: cloud.html | ||
keywords: | ||
summary: | ||
--- | ||
= クラウド | ||
:hardbreaks: | ||
:nofooter: | ||
:icons: font | ||
:linkattrs: | ||
:imagesdir: ./media/ | ||
|
||
|
||
[role="lead"] | ||
クラウドのオブジェクトストレージリソースへの接続の管理に使用できる API 呼び出しを次に示します。 | ||
|
||
|
||
|
||
==== ターゲット | ||
|
||
ターゲットはクラウド内のオブジェクトストレージリソースを表します。各ターゲットには、ストレージリソースへの接続に必要な設定情報が含まれます。このリソースタイプは ONTAP 9.6 で導入されました。 |
Oops, something went wrong.