Ptables

>>>

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": [
    {
      "description": null,
      "os_family": null,
      "created_at": "2019-11-07 09:06:52 UTC",
      "updated_at": "2019-11-07 09:06:52 UTC",
      "name": "Example partition table",
      "id": 615088209
    },
    {
      "description": null,
      "os_family": "Redhat",
      "created_at": "2019-11-07 09:07:17 UTC",
      "updated_at": "2019-11-07 09:07:17 UTC",
      "name": "ptable813",
      "id": 1007981737
    }
  ]
}

パラメーター

パラメーター名 記述
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/1007981743-ptable819
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,
  "description": null,
  "os_family": "Redhat",
  "created_at": "2019-11-07 09:07:17 UTC",
  "updated_at": "2019-11-07 09:07:17 UTC",
  "name": "ptable819",
  "id": 1007981743,
  "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
任意

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

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": "",
    "layout": "d-i partman-auto/disk"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer
ptable
必須

Validations:

  • Must be a Hash
ptable[name]
必須

Validations:

  • Must be a String
ptable[description]
任意 , nil可

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": "ptable824",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "ptable824",
  "id": 1007981749,
  "snippet": false,
  "description": null,
  "template_kind_id": null,
  "created_at": "2019-11-07T09:07:18.340Z",
  "updated_at": "2019-11-07T09:07:18.356Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": "Redhat"
}

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

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
任意

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer
version
任意

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

Validations:

  • Must be a String
>>>

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

例

PUT /api/ptables/1007981738
{
  "ptable": {
    "layout": "new ptable layout"
  }
}
200
{
  "layout": "new ptable layout",
  "locked": false,
  "description": null,
  "os_family": "Redhat",
  "created_at": "2019-11-07 09:07:17 UTC",
  "updated_at": "2019-11-07 09:07:17 UTC",
  "name": "ptable814",
  "id": 1007981738,
  "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
任意

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

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[description]
任意 , nil可

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/1007981740-ptable816
{
  "ptable": {}
}
422
{
  "error": {
    "id": 1007981740,
    "errors": {
      "base": [
        "ptable816 is used by host2478"
      ]
    },
    "full_messages": [
      "ptable816 is used by host2478"
    ]
  }
}

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be a String
>>>

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

例

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

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

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/1007981755-ptable829/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: ptable829
snippet: false
model: Ptable
os_family: Redhat
organizations:
- Organization 1
locations:
- Location 1
%>

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
任意

Set the current organization context for the request

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.