Documentation

アドホックコマンドリストの API エンドポイント

このリソースに GET リクエストを実行して、アドホックコマンドのリストを取得します。

GET /api/v1/ad_hoc_commands/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.053s

返されるデータ構造には以下のものが含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

count フィールドはクエリーで見つかったアドホックコマンドの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはアドホックコマンドが一覧表示されますが、ゼロの場合もあります。

結果

各アドホックコマンドのデータ構造には以下のフィールドが含まれます。

  • id: アドホックコマンドのデータベース ID (整数)
  • type: アドホックコマンドのデータタイプ (複数選択)
    -ad_hoc_command: コマンド
  • url: アドホックコマンドの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • created: アドホックコマンド作成時のタイムスタンプ (日時)
  • modified: アドホックコマンドの最終更新時のタイムスタンプ (日時)
  • name: (文字列)
  • launch_type: (複数選択)
    • manual: 手動
    • callback: コールバック
    • scheduled: スケジュール済み
    • dependency: 依存関係
  • status: (複数選択)
    • new: 新規
    • pending: 保留中
    • waiting: 待機中
    • running: 実行中
    • successful: 成功
    • failed: 失敗
    • error: エラー
    • canceled: キャンセル済み
  • failed: (ブール値)
  • started: (日時)
  • finished: (日時)
  • elapsed: (10 進数)
  • job_explanation: (文字列)
  • job_type: (複数選択)
    • run: 実行
    • check: チェック
    • scan: スキャン
  • inventory: (フィールド)
  • limit: (文字列)
  • credential: (フィールド)
  • module_name: (複数選択)
    • command
    • shell
    • yum
    • apt
    • apt_key
    • apt_repository
    • apt_rpm
    • service
    • group
    • user
    • mount
    • ping
    • selinux
    • setup
    • win_ping
    • win_service
    • win_updates
    • win_group
    • win_user
  • module_args: (文字列)
  • forks: (整数)
  • verbosity: (複数選択)
    • 0: 0 (正常)
    • 1: 1 (詳細)
    • 2: 2 (より詳細)
    • 3: 3 (デバッグ)
    • 4: 4 (接続デバッグ)
    • 5: 5 (WinRM デバッグ)
  • become_enabled: (ブール値)

アドホックコマンドの作成

新規アドホックコマンドを作成するには、以下のアドホックコマンドのフィールドを使ってリソースに POST リクエストを実行します。

  • job_type: (複数選択。必須)
    • run: 実行 (デフォルト)
    • check: チェック
    • scan: スキャン
  • inventory: (フィールド。デフォルトは None)
  • limit: (文字列。デフォルトは "")
  • credential: (フィールド。デフォルトは None)
  • module_name: (複数選択)
    • command (デフォルト)
    • shell
    • yum
    • apt
    • apt_key
    • apt_repository
    • apt_rpm
    • service
    • group
    • user
    • mount
    • ping
    • selinux
    • setup
    • win_ping
    • win_service
    • win_updates
    • win_group
    • win_user
  • module_args: (文字列。デフォルトは "")
  • forks: (整数。デフォルトは 0)
  • verbosity: (複数選択)
    • 0: 0 (正常。これがデフォルト)
    • 1: 1 (詳細)
    • 2: 2 (より詳細)
    • 3: 3 (デバッグ)
    • 4: 4 (接続デバッグ)
    • 5: 5 (WinRM デバッグ)
  • become_enabled: (ブール値。デフォルトは False)

(アドホックコマンドは Ansible Tower バージョン 2.2.0 で追加されています。)

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name Ad Hoc Command List
description # List Ad Hoc Commands: Make a GET request to this resource to retrieve the list of ad hoc commands.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 2.2.0
actions
POST
job_type
type multiple choice
required
true
label job type
default run
choices
0
0 run
1 Run
1
0 check
1 Check
2
0 scan
1 Scan
inventory
type field
required
false
default null
limit
type string
required
false
label limit
max_length 1024
default (Empty Text)
credential
type field
required
false
default null
module_name
type multiple choice
required
false
label module name
default command
choices
0
0 command
1 command
1
0 shell
1 shell
2
0 yum
1 yum
3
0 apt
1 apt
4
0 apt_key
1 apt_key
5
0 apt_repository
1 apt_repository
6
0 apt_rpm
1 apt_rpm
7
0 service
1 service
8
0 group
1 group
9
0 user
1 user
10
0 mount
1 mount
11
0 ping
1 ping
12
0 selinux
1 selinux
13
0 setup
1 setup
14
0 win_ping
1 win_ping
15
0 win_service
1 win_service
16
0 win_updates
1 win_updates
17
0 win_group
1 win_group
18
0 win_user
1 win_user
module_args
type string
required
false
label module args
default (Empty Text)
forks
type integer
required
false
label forks
default 0
verbosity
type multiple choice
required
false
label verbosity
default 0
choices
0
0 0
1 0 (Normal)
1
0 1
1 1 (Verbose)
2
0 2
1 2 (More Verbose)
3
0 3
1 3 (Debug)
4
0 4
1 4 (Connection Debug)
5
0 5
1 5 (WinRM Debug)
become_enabled
type boolean
required
false
label become enabled
default
false
GET
id
type integer
label ID
help_text Database ID for this ad hoc command.
type
type multiple choice
help_text Data type for this ad hoc command.
choices
0
0 ad_hoc_command
1 Command
url
type string
help_text URL for this ad hoc command.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this ad hoc command was created.
modified
type datetime
help_text Timestamp when this ad hoc command was last modified.
name
type string
launch_type
type multiple choice
label launch type
choices
0
0 manual
1 Manual
1
0 callback
1 Callback
2
0 scheduled
1 Scheduled
3
0 dependency
1 Dependency
status
type multiple choice
label status
choices
0
0 new
1 New
1
0 pending
1 Pending
2
0 waiting
1 Waiting
3
0 running
1 Running
4
0 successful
1 Successful
5
0 failed
1 Failed
6
0 error
1 Error
7
0 canceled
1 Canceled
failed
type boolean
label failed
started
type datetime
label started
finished
type datetime
label finished
elapsed
type decimal
label elapsed
job_explanation
type string
label job explanation
job_type
type multiple choice
label job type
choices
0
0 run
1 Run
1
0 check
1 Check
2
0 scan
1 Scan
inventory
type field
limit
type string
label limit
credential
type field
module_name
type multiple choice
label module name
choices
0
0 command
1 command
1
0 shell
1 shell
2
0 yum
1 yum
3
0 apt
1 apt
4
0 apt_key
1 apt_key
5
0 apt_repository
1 apt_repository
6
0 apt_rpm
1 apt_rpm
7
0 service
1 service
8
0 group
1 group
9
0 user
1 user
10
0 mount
1 mount
11
0 ping
1 ping
12
0 selinux
1 selinux
13
0 setup
1 setup
14
0 win_ping
1 win_ping
15
0 win_service
1 win_service
16
0 win_updates
1 win_updates
17
0 win_group
1 win_group
18
0 win_user
1 win_user
module_args
type string
label module args
forks
type integer
label forks
verbosity
type multiple choice
label verbosity
choices
0
0 0
1 0 (Normal)
1
0 1
1 1 (Verbose)
2
0 2
1 2 (More Verbose)
3
0 3
1 3 (Debug)
4
0 4
1 4 (Connection Debug)
5
0 5
1 5 (WinRM Debug)
become_enabled
type boolean
label become enabled
types
0 ad_hoc_command
search_fields
0 description
1 name