GET /api/ptables
すべてのパーティションテーブルを一覧表示

GET /api/operatingsystems/:operatingsystem_id/ptables
オペレーティングシステムのすべてのパーティションテーブルを一覧表示

GET /api/locations/:location_id/ptables
ロケーションごとのすべてのパーティションテーブルを一覧表示

GET /api/organizations/:organization_id/ptables
組織ごとのすべてのパーティションテーブルを一覧表示

GET /api/ptables
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "os_family": null,
      "created_at": "2019-09-11 14:34:13 UTC",
      "updated_at": "2019-09-11 14:34:13 UTC",
      "name": "Example partition table",
      "id": 615088209
    },
    {
      "os_family": "Redhat",
      "created_at": "2019-09-11 14:34:42 UTC",
      "updated_at": "2019-09-11 14:34:42 UTC",
      "name": "ptable214",
      "id": 1007981802
    }
  ]
}

パラメーター

パラメーター名 記述
operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
default true, false
family string
layout text
location string
location_id integer
locked true, false
name string
organization string
organization_id integer
snippet true, false
template text
vendor string

GET /api/ptables/:id
パーティションテーブルの表示

GET /api/ptables/1007981804-ptable216
200
{
  "layout": "zerombr\\nclearpart --all    --initlabel\\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\\npart /     --f   stype ext3 --size=1024 --grow\\npart swap  --recommended",
  "locked": false,
  "os_family": "Redhat",
  "created_at": "2019-09-11 14:34:43 UTC",
  "updated_at": "2019-09-11 14:34:43 UTC",
  "name": "ptable216",
  "id": 1007981804,
  "operatingsystems": [
    {
      "id": 1073012828,
      "name": "Redhat",
      "title": "RHEL 6.1"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/ptables
パーティションテーブルの作成

POST /api/ptables
{
  "ptable": {
    "name": "W",
    "layout": "d-i partman-auto/disk"
  }
}
201
{
  "layout": "d-i partman-auto/disk",
  "locked": false,
  "os_family": null,
  "created_at": "2019-09-11 14:34:42 UTC",
  "updated_at": "2019-09-11 14:34:42 UTC",
  "name": "W",
  "id": 1007981781,
  "operatingsystems": [],
  "locations": [],
  "organizations": []
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

ptable
必須

Validations:

  • Must be a Hash

ptable[name]
必須

Validations:

  • Must be a String

ptable[layout]
必須

Validations:

  • Must be a String

ptable[snippet]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

ptable[audit_comment]
任意 , nil可

Validations:

  • Must be a String

ptable[locked]
任意 , nil可

テンプレートを編集用にロックするかどうか

Validations:

  • Must be one of: true, false, 1, 0.

ptable[os_family]
任意 , nil可

Validations:

  • Must be a String

ptable[operatingsystem_ids]
任意 , nil可

パーティションテーブルに関連付けるオペレーティングシステム ID の配列

Validations:

  • Must be an array of any type

ptable[host_ids]
任意 , nil可

パーティションテーブルに関連付けるホスト ID の配列

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
任意 , nil可

パーティションテーブルに関連付けるホストグループ ID の配列

Validations:

  • Must be an array of any type

ptable[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

ptable[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


POST /api/ptables/import
プロビジョニングテンプレートのインポート

POST /api/ptables/import
{
  "ptable": {
    "name": "ptable212",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "ptable212",
  "id": 1007981800,
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-09-11T14:34:42.858Z",
  "updated_at": "2019-09-11T14:34:42.873Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": "Redhat"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

ptable
必須

Validations:

  • Must be a Hash

ptable[name]
任意

テンプレート名

Validations:

  • Must be a String

ptable[template]
任意

メタデータを含むテンプレートコンテンツ

Validations:

  • Must be a String

ptable[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

ptable[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type

options
任意

Validations:

  • Must be a Hash

options[force]
任意 , nil可

ロックしたテンプレートを更新したい場合に使用

Validations:

  • Must be one of: true, false, 1, 0.

options[associate]
任意 , nil可

テンプレートがオブジェクトをメタデータに基づいて関連付ける場合を決定します。new は新規テンプレートが作成中であることを意味します。always は、新規および更新中の既存のテンプレートを意味します。never はメタデータを無視します

Validations:

  • Must be one of: new, always, never.

options[lock]
任意 , nil可

インポートされたテンプレートをロックします (デフォルトは false)

Validations:

  • Must be one of: true, false, 1, 0.

options[default]
任意 , nil可

テンプレートにデフォルトで意味付けし、新たに作成された組織と場所に自動的に関連付けます (デフォルトは false)

Validations:

  • Must be one of: true, false, 1, 0.


GET /api/ptables/revision

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

version
任意

テンプレートのバージョン

Validations:

  • Must be a String


PUT /api/ptables/:id
パーティションテーブルの更新

PUT /api/ptables/1007981787-ptable201
{
  "ptable": {
    "audit_comment": "aha",
    "template": "tmp"
  }
}
200
{
  "layout": "tmp",
  "locked": false,
  "os_family": "Redhat",
  "created_at": "2019-09-11 14:34:42 UTC",
  "updated_at": "2019-09-11 14:34:42 UTC",
  "name": "ptable201",
  "id": 1007981787,
  "operatingsystems": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String

ptable
必須

Validations:

  • Must be a Hash

ptable[name]
任意

Validations:

  • Must be a String

ptable[layout]
任意

Validations:

  • Must be a String

ptable[snippet]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

ptable[audit_comment]
任意 , nil可

Validations:

  • Must be a String

ptable[locked]
任意 , nil可

テンプレートを編集用にロックするかどうか

Validations:

  • Must be one of: true, false, 1, 0.

ptable[os_family]
任意 , nil可

Validations:

  • Must be a String

ptable[operatingsystem_ids]
任意 , nil可

パーティションテーブルに関連付けるオペレーティングシステム ID の配列

Validations:

  • Must be an array of any type

ptable[host_ids]
任意 , nil可

パーティションテーブルに関連付けるホスト ID の配列

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
任意 , nil可

パーティションテーブルに関連付けるホストグループ ID の配列

Validations:

  • Must be an array of any type

ptable[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

ptable[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/ptables/:id
パーティションテーブルの解除

DELETE /api/ptables/1007981794-ptable206
{
  "ptable": {}
}
422
{
  "error": {
    "id": 1007981794,
    "errors": {
      "base": [
        "ptable206 is used by host312"
      ]
    },
    "full_messages": [
      "ptable206 is used by host312"
    ]
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String


POST /api/ptables/:id/clone
テンプレートのクローン

POST /api/ptables/1007981806-ptable218/clone
{
  "ptable": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 1007981806,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

ptable
必須

Validations:

  • Must be a Hash

ptable[name]
必須

テンプレート名

Validations:

  • Must be a String


GET /api/ptables/:id/export
パーティションテンプレートを ERB にエクスポート

GET /api/ptables/1007981785-ptable199/export
200
zerombr\nclearpart --all    --initlabel\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\npart /     --f   stype ext3 --size=1024 --grow\npart swap  --recommended
<%#
name: ptable199
snippet: false
model: Ptable
os_family: Redhat
organizations:
- Organization 1
locations:
- Location 1
%>

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.