6.5 Script

以下にScript定義と定義例を示します。スクリプトの詳細については「UI設計」を参照してください。
ScriptのYAMLファイル内で定義するアクションのスクリプトのバージョンは、UIのUIバージョンにあわせる必要がありますが、Scriptは常に以下のapiVersion1.0のYAML定義になります。UIバージョンの詳細は「UIバージョン」を参照してください。

（表）Script定義

ラベル デフォルト値 必須※ 説明
apiVersion: Yes APIバージョン
1.0を指定する
kind: Yes scriptを指定する
type: No resourceを指定する
Ops Iの運用機能に追加する新しい定義であることを示す
name: Yes Script定義の内部名
nameは以下のルールに従う必要があります。
  • 本YAMLファイルのディレクトリ名を指定
  • 入力可能な文字は以下の通り
    • 半角英数字：
      a～z A～Z 0～9
    • 半角の特殊文字：
      _ . ( ) -
  • 先頭文字が半角英数字かアンダーバー（_）
  • その他の注意点は「YAMLファイル作成時の注意」2～4を参照
label: Yes YAMLファイルに記載する運用機能の表示名
includes: No このYAMLファイルで利用する関連YAMLファイルを記載
メモメモ
  • 記載するYAMLファイルはこのYAMLファイル登録前にOps Iに登録されている必要があります。
  • includesラベルを指定することにより、他のYAMLファイルで定義した内容を取り込むことができます。
- kind: Yes 読み込むYAMLファイルの種類
  name: Yes 読み込むYAMLファイルの内部名
description: No このYAMLファイルに対する詳細説明
actions: Yes アクションを定義
- name: Yes アクション名
  file: Yes アクションの内容を記述したスクリプトファイルのパス。スクリプトのYAMLファイルが保存されているディレクトリが起点となる。
例）
作成したスクリプトをsample.jsとし、scriptのYAMLファイルが保存されているディレクトリにsample.jsが保存されている場合、当該スクリプトのファイルパスは以下となる。
sample.js
※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。

アクションが定義可能なコンポーネントの一覧については、以下を参照してください。


＜定義例＞

apiVersion: 1.0
kind: script

type: resource
name: create_vm
label: create_vm
description: VM生成を行うカスタムスクリプトです。

actions:
  - name: create_vm_action
    file: create_vm_action.js



節構成

6.5.1 アクションのスクリプト（UIバージョン1.0）
6.5.2 アクションのスクリプト（UIバージョン1.1）