ジョブ更新ポリシータイプ

ジョブ更新ポリシーを使うと、エンドポイント上のジョブ定義を一元的に配布・更新・削除できます。

仕組み (概要)

エージェントは、PolicyType が "JobUpdate" のポリシーを処理します。Extension の内容に応じて、エンドポイント上の Jobs/{JobId}.json のジョブ定義を追加・更新・削除します。

手順: Update Jobsポリシーの作成 (高度なJSONから)

エンドポイント特権マネージャー → [ポリシー] に移動

[ポリシーの作成] ボタンをクリック

ポリシー作成用のモーダルが開きます。

ポリシー属性の定義

新しいポリシーには、適切で分かりやすい名前を付けます。

新規ポリシーでは、UIに表示されている既存のポリシータイプのいずれかを選びます (あくまで作成時のテンプレートであり、ジョブ更新は後述のJSONで指定します)。

ステータスを選びます。初めてポリシーを用意するときは、監視を推奨します。

[コントロールを追加] をクリックしてコントロールを1つ以上追加し、新しいポリシーに含めたいコントロールを選びます。

ユーザーグループ、マシンコレクション、アプリケーションコレクションを指定します。

ポリシーの適用対象の設定

UIで、コレクション/ユーザー/マシン/アプリ/プラットフォームなどから、必要な適用対象を設定し、ポリシーの適用先を決めます。

Advanced Mode (JSONビュー) を開く

ポリシーフォーム左下の [Advanced Mode] のリンクをクリックして開きます。

JSONでポリシータイプを再定義

Extensionフィールドの定義

このドキュメントの必須の拡張フィールドに沿って、Extension の各フィールドを設定します。

ポリシーを保存

必須の拡張フィールド

Extension.JobId: ジョブ識別子。エージェントが Jobs/{JobId}.json を書き込み/削除するときのキー
Extension.Action: "Add"、"Update"、または "Delete"
Extension.JobJson: 追加・更新の際に必須。削除の際は省略

IDの要件: JobJson 内の id は、必ず JobId と同じ値にします。

JSONの例

例1: ジョブの追加 (JobUpdate / Action=Add)

{
  "PolicyName": "Update Jobs - Add Maintenance Job",
  "PolicyType": "JobUpdate",
  "PolicyId": "REPLACE_WITH_ID",
  "Status": "on",
  "Actions": {
    "OnSuccess": {
      "Controls": [
        "NOTIFY"
      ]
    },
    "OnFailure": {
      "Command": ""
    }
  },
  "NotificationMessage": "A job was added to this endpoint via policy.",
  "NotificationRequiresAcknowledge": false,
  "RiskLevel": 20,
  "Operator": "And",
  "Rules": [
    {
      "RuleName": "UserCheck",
      "ErrorMessage": "This user is not included in this policy",
      "RuleExpressionType": "BuiltInAction",
      "Expression": "CheckUser()"
    },
    {
      "RuleName": "MachineCheck",
      "ErrorMessage": "This Machine is not included in this policy",
      "RuleExpressionType": "BuiltInAction",
      "Expression": "CheckMachine()"
    }
  ],
  "UserCheck": [],
  "MachineCheck": [],
  "ApplicationCheck": [],
  "DayCheck": [],
  "DateCheck": [],
  "TimeCheck": [],
  "CertificationCheck": [],
  "Extension": {
    "JobId": "my-maintenance-job",
    "Action": "Add",
    "JobJson": "{\n  \"id\": \"my-maintenance-job\",\n  \"name\": \"My Maintenance Job\",\n  \"description\": \"Runs periodic maintenance actions.\",\n  \"enabled\": true,\n  \"schedule\": {\n    \"type\": \"interval\",\n    \"minutes\": 60\n  },\n  \"tasks\": [\n    {\n      \"type\": \"command\",\n      \"name\": \"Example Task\",\n      \"command\": \"echo Maintenance job ran\"\n    }\n  ]\n}"
  }
}

注

Extension.JobJson は、ジョブ定義のJSONを1本の文字列として渡すフィールドです (中身はジョブJSONの全体)。
内側のジョブJSONに "id": "my-maintenance-job" を含め、JobId と一致させてください。

例2: 既存ジョブの更新 (JobUpdate / Action=Update)

{
  "PolicyName": "Update Jobs - Update Maintenance Job",
  "PolicyType": "JobUpdate",
  "PolicyId": "REPLACE_WITH_ID",
  "Status": "on",
  "Actions": {
    "OnSuccess": {
      "Controls": [
        "NOTIFY"
      ]
    },
    "OnFailure": {
      "Command": ""
    }
  },
  "NotificationMessage": "A job was updated on this endpoint via policy.",
  "NotificationRequiresAcknowledge": false,
  "RiskLevel": 20,
  "Operator": "And",
  "Rules": [
    {
      "RuleName": "UserCheck",
      "ErrorMessage": "This user is not included in this policy",
      "RuleExpressionType": "BuiltInAction",
      "Expression": "CheckUser()"
    },
    {
      "RuleName": "MachineCheck",
      "ErrorMessage": "This Machine is not included in this policy",
      "RuleExpressionType": "BuiltInAction",
      "Expression": "CheckMachine()"
    }
  ],
  "UserCheck": [],
  "MachineCheck": [],
  "ApplicationCheck": [],
  "DayCheck": [],
  "DateCheck": [],
  "TimeCheck": [],
  "CertificationCheck": [],
  "Extension": {
    "JobId": "my-maintenance-job",
    "Action": "Update",
    "JobJson": "{\n  \"id\": \"my-maintenance-job\",\n  \"name\": \"My Maintenance Job\",\n  \"description\": \"Runs periodic maintenance actions (updated schedule).\",\n  \"enabled\": true,\n  \"schedule\": {\n    \"type\": \"interval\",\n    \"minutes\": 30\n  },\n  \"tasks\": [\n    {\n      \"type\": \"command\",\n      \"name\": \"Example Task\",\n      \"command\": \"echo Maintenance job ran (updated)\"\n    }\n  ]\n}"
  }
}

注

更新では通常、JobJson で渡した内容によりジョブファイル全体が置き換わるため、ジョブスキーマで必要なフィールドはすべて含めます。

例3: ジョブの削除 (JobUpdate / Action=Delete)

{
  "PolicyName": "Update Jobs - Delete Maintenance Job",
  "PolicyType": "JobUpdate",
  "PolicyId": "REPLACE_WITH_ID",
  "Status": "on",
  "Actions": {
    "OnSuccess": {
      "Controls": [
        "NOTIFY"
      ]
    },
    "OnFailure": {
      "Command": ""
    }
  },
  "NotificationMessage": "A job was deleted from this endpoint via policy.",
  "NotificationRequiresAcknowledge": false,
  "RiskLevel": 20,
  "Operator": "And",
  "Rules": [
    {
      "RuleName": "UserCheck",
      "ErrorMessage": "This user is not included in this policy",
      "RuleExpressionType": "BuiltInAction",
      "Expression": "CheckUser()"
    },
    {
      "RuleName": "MachineCheck",
      "ErrorMessage": "This Machine is not included in this policy",
      "RuleExpressionType": "BuiltInAction",
      "Expression": "CheckMachine()"
    }
  ],
  "UserCheck": [],
  "MachineCheck": [],
  "ApplicationCheck": [],
  "DayCheck": [],
  "DateCheck": [],
  "TimeCheck": [],
  "CertificationCheck": [],
  "Extension": {
    "JobId": "my-maintenance-job",
    "Action": "Delete"
  }
}

注

Delete のときは JobJson を書かないでください。

運用でよく変える項目

PolicyId: UIで採番された値のままにします。
Status: 展開状況に応じて "on" / "off" を切り替えます。
UserCheck / MachineCheck: コンソールの通常の適用対象と同じ要領で配列を埋めます。
Extension.JobId: ファイル名のキー (エンドポイント上では Jobs/{JobId}.json になります)。
Extension.JobJson: 追加・更新用にジョブ定義全体を文字列化したもの。

エンドポイントでの検証

追加・更新の際は、Jobs/{JobId}.json が存在し、渡したジョブJSONの内容と一致していることを確認します。
削除の際は、Jobs/{JobId}.json がなくなっていることを確認します。

前へHTTPアクセスポリシータイプ次へ設定更新ポリシータイプ

最終更新 5 日前