GET /api/provisioning_templates
Listar plantillas de aprovisionamiento

GET /api/operatingsystems/:operatingsystem_id/provisioning_templates
Listar plantillas de aprovisionamiento por sistema operativo

GET /api/locations/:location_id/provisioning_templates
Listar plantillas de aprovisionamiento por ubicación

GET /api/organizations/:organization_id/provisioning_templates
Listar plantillas de aprovisionamiento por organización

Ejemplos

GET /api/provisioning_templates
200
{
  "total": 14,
  "subtotal": 14,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 1007981701,
      "name": "centos5_3_pxelinux",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 698706415,
      "name": "iPXE Dummy Menu",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 718456980,
      "name": "Locked Template",
      "template_kind_id": 983253650,
      "template_kind_name": "provision"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 104314179,
      "name": "MyFinish",
      "template_kind_id": 550103832,
      "template_kind_name": "finish"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 981457253,
      "name": "MyScript",
      "template_kind_id": 478250810,
      "template_kind_name": "script"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 943779058,
      "name": "MyString",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 269958254,
      "name": "MyString2",
      "template_kind_id": 983253650,
      "template_kind_name": "provision"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 684651467,
      "name": "PXE Default Menu",
      "template_kind_id": 710512633,
      "template_kind_name": null
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 554905648,
      "name": "PXEGrub2 global default",
      "template_kind_id": 701398793,
      "template_kind_name": "PXEGrub2"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 131565194,
      "name": "PXEGrub Dummy Menu",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 824224502,
      "name": "PXEGrub global default",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 821548108,
      "name": "PXELinux default local boot",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 352050261,
      "name": "PXELinux global default",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "audit_comment": null,
      "created_at": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 56083308,
      "name": "suse_pxelinux",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
operatingsystem_id
opcional

ID del sistema operativo

Validations:

  • Must be a String

location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
default_template true, false
environment string
hostgroup string
kind string
location string
location_id integer
locked true, false
name string
operatingsystem string
organization string
organization_id integer
snippet true, false
template text
vendor string

GET /api/provisioning_templates/:id
Mostrar detalles de la plantilla de aprovisionamiento

Ejemplos

GET /api/provisioning_templates/1007981701-centos5_3_pxelinux
200
{
  "template": "default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\"kickstart\")%> ksdevice=bootif network kssendmac",
  "locked": false,
  "snippet": false,
  "description": null,
  "audit_comment": null,
  "created_at": "2019-11-07 08:44:12 UTC",
  "updated_at": "2019-11-07 08:44:12 UTC",
  "id": 1007981701,
  "name": "centos5_3_pxelinux",
  "template_kind_id": 452984334,
  "template_kind_name": "PXELinux",
  "template_combinations": [],
  "operatingsystems": [
    {
      "id": 309172073,
      "name": "centos",
      "title": "centos 5.3"
    },
    {
      "id": 1073012828,
      "name": "Redhat",
      "title": "RHEL 6.1"
    },
    {
      "id": 331303656,
      "name": "Ubuntu",
      "title": "Ubuntu 10.10"
    }
  ],
  "os_default_templates": [
    {
      "id": 281110143,
      "provisioning_template_id": 1007981701,
      "provisioning_template_name": "centos5_3_pxelinux",
      "template_kind_id": 710512633,
      "template_kind_name": null,
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1",
      "config_template_id": 1007981701,
      "config_template_name": "centos5_3_pxelinux"
    },
    {
      "id": 638205575,
      "provisioning_template_id": 1007981701,
      "provisioning_template_name": "centos5_3_pxelinux",
      "template_kind_id": 710512633,
      "template_kind_name": null,
      "operatingsystem_id": 331303656,
      "operatingsystem_name": "Ubuntu 10.10",
      "config_template_id": 1007981701,
      "config_template_name": "centos5_3_pxelinux"
    }
  ],
  "locations": [],
  "organizations": []
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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/provisioning_templates
Crear una plantilla de aprovisionamiento

Ejemplos

POST /api/provisioning_templates
{
  "provisioning_template": {
    "template": "This is a test template",
    "template_kind_id": 131565194,
    "name": "new_template"
  }
}
201
{
  "template": "This is a test template",
  "locked": false,
  "snippet": false,
  "description": null,
  "audit_comment": null,
  "created_at": "2019-11-07 08:44:13 UTC",
  "updated_at": "2019-11-07 08:44:13 UTC",
  "id": 1007981703,
  "name": "new_template",
  "template_kind_id": 131565194,
  "template_kind_name": "PXEGrub",
  "template_combinations": [],
  "operatingsystems": [],
  "os_default_templates": [],
  "locations": [],
  "organizations": []
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

provisioning_template
requerido

Validations:

  • Must be a Hash

provisioning_template[name]
requerido

nombre de plantilla

Validations:

  • Must be a String

provisioning_template[description]
opcional , nil permitido

Validations:

  • Must be a String

provisioning_template[template]
requerido

Validations:

  • Must be a String

provisioning_template[snippet]
opcional , nil permitido

Validations:

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

provisioning_template[audit_comment]
opcional , nil permitido

Validations:

  • Must be a String

provisioning_template[template_kind_id]
opcional , nil permitido

no es relevante para ‘snippet’

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
opcional , nil permitido

Array de combinaciones de plantillas (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
opcional , nil permitido

Array de ID de sistemas operativos a asociar con la plantilla

Validations:

  • Must be an array of any type

provisioning_template[locked]
opcional , nil permitido

Si la plantilla está bloqueada o no para edición

Validations:

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

provisioning_template[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


POST /api/provisioning_templates/import
Importar una plantilla de aprovisionamiento

Ejemplos

POST /api/provisioning_templates/import
{
  "provisioning_template": {
    "name": "provisioning_template110",
    "template": "<%#\nsnippet: true\n-%>\nbbbb"
  }
}
201
{
  "template": "<%#\nsnippet: true\n-%>\nbbbb",
  "name": "provisioning_template110",
  "id": 1007981707,
  "snippet": true,
  "description": null,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:44:14.418Z",
  "updated_at": "2019-11-07T08:44:14.439Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

provisioning_template
requerido

Validations:

  • Must be a Hash

provisioning_template[name]
opcional

nombre de plantilla

Validations:

  • Must be a String

provisioning_template[template]
opcional

contenidos de plantillas incluidos los metadatos

Validations:

  • Must be a String

provisioning_template[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type

options
opcional

Validations:

  • Must be a Hash

options[force]
opcional , nil permitido

utilizar si desea actualizar las plantillas bloqueadas

Validations:

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

options[associate]
opcional , nil permitido

determina los casos en que la plantilla debería asociar objetos en función de los metadatos, nuevo se aplica solo a los casos de plantilla nueva que se está creando, siempre se aplica tanto a plantilla nueva como existente que solo se están actualizando, nunca ignora los metadatos

Validations:

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

options[lock]
opcional , nil permitido

bloquear plantillas importadas (falso de manera predeterminada)

Validations:

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

options[default]
opcional , nil permitido

configura la plantilla como predeterminada, lo que significa que se asociará automáticamente con las ubicaciones y organizaciones nuevas creadas (falso de manera predeterminada)

Validations:

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


PUT /api/provisioning_templates/:id
Actualizar una plantilla de aprovisionamiento

Ejemplos

PUT /api/provisioning_templates/1007981701-centos5_3_pxelinux
{
  "provisioning_template": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 1007981701,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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

provisioning_template
requerido

Validations:

  • Must be a Hash

provisioning_template[name]
opcional

nombre de plantilla

Validations:

  • Must be a String

provisioning_template[description]
opcional , nil permitido

Validations:

  • Must be a String

provisioning_template[template]
opcional

Validations:

  • Must be a String

provisioning_template[snippet]
opcional , nil permitido

Validations:

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

provisioning_template[audit_comment]
opcional , nil permitido

Validations:

  • Must be a String

provisioning_template[template_kind_id]
opcional , nil permitido

no es relevante para ‘snippet’

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
opcional , nil permitido

Array de combinaciones de plantillas (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
opcional , nil permitido

Array de ID de sistemas operativos a asociar con la plantilla

Validations:

  • Must be an array of any type

provisioning_template[locked]
opcional , nil permitido

Si la plantilla está bloqueada o no para edición

Validations:

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

provisioning_template[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


GET /api/provisioning_templates/revision

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

version
opcional

versión de plantilla

Validations:

  • Must be a String


DELETE /api/provisioning_templates/:id
Borrar una plantilla de aprovisionamiento

Ejemplos

DELETE /api/provisioning_templates/1007981701-centos5_3_pxelinux
{
  "provisioning_template": {}
}
422
{
  "error": {
    "id": 1007981701,
    "errors": {
      "base": [
        "centos5_3_pxelinux is used by Redhat 6.1 - ",
        "centos5_3_pxelinux is used by Ubuntu 10.10 - "
      ]
    },
    "full_messages": [
      "centos5_3_pxelinux is used by Redhat 6.1 - ",
      "centos5_3_pxelinux is used by Ubuntu 10.10 - "
    ]
  }
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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/provisioning_templates/build_pxe_default
Actualizar el menú PXE predeterminado en todos los servidores TFTP configurados

Ejemplos

POST /api/provisioning_templates/build_pxe_default
{
  "provisioning_template": {}
}
200
{
  "message": "PXE files for templates PXEGrub2 global default, PXELinux global default, and PXEGrub global default have been deployed to all Smart Proxies"
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer


POST /api/provisioning_templates/:id/clone
Clonar una plantilla de aprovisionamiento

Ejemplos

POST /api/provisioning_templates/1007981701-centos5_3_pxelinux/clone
{
  "provisioning_template": {
    "name": "MyClone"
  }
}
201
{
  "id": 1007981702,
  "name": "MyClone",
  "template": "default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\"kickstart\")%> ksdevice=bootif network kssendmac",
  "snippet": false,
  "template_kind_id": 452984334,
  "created_at": "2019-11-07T08:44:13.551Z",
  "updated_at": "2019-11-07T08:44:13.551Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null,
  "description": null
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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

provisioning_template
requerido

Validations:

  • Must be a Hash

provisioning_template[name]
requerido

nombre de plantilla

Validations:

  • Must be a String


GET /api/provisioning_templates/:id/export
Exportar una plantilla de aprovisionamiento a ERB

Ejemplos

GET /api/provisioning_templates/1007981701-centos5_3_pxelinux/export
200
default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url("kickstart")%> ksdevice=bootif network kssendmac
<%#
name: centos5_3_pxelinux
snippet: false
model: ProvisioningTemplate
kind: PXELinux
oses:
- centos
- Redhat
- Ubuntu
%>

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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