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
необязательно

Код операционной системы

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
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
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 разрешен

Массив кодов операционных систем связанных с таблицей разделов

Validations:

  • Must be an array of any type

ptable[host_ids]
необязательно , nil разрешен

Массив кодов узлов связанных с таблицей разделов

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
необязательно , nil разрешен

Массив кодов групп узлов связанных с таблицей разделов

Validations:

  • Must be an array of any type

ptable[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

ptable[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


POST /api/ptables/import
Import a provisioning template

Примеры

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]
необязательно

template contents including metadata

Validations:

  • Must be a String

ptable[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

ptable[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type

options
необязательно

Validations:

  • Must be a Hash

options[force]
необязательно , nil разрешен

use if you want update locked templates

Validations:

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

options[associate]
необязательно , nil разрешен

determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

Validations:

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

options[lock]
необязательно , nil разрешен

lock imported templates (false by default)

Validations:

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

options[default]
необязательно , nil разрешен

makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

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 разрешен

Массив кодов операционных систем связанных с таблицей разделов

Validations:

  • Must be an array of any type

ptable[host_ids]
необязательно , nil разрешен

Массив кодов узлов связанных с таблицей разделов

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
необязательно , nil разрешен

Массив кодов групп узлов связанных с таблицей разделов

Validations:

  • Must be an array of any type

ptable[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

ptable[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

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
Export a partition template to 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.