GET /katello/api/host_collections/:id
Exibir uma coleção de host

Parâmentros

Nome parâmetro Descrição
id
requerido

ID da coleção do host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


GET /katello/api/host_collections
Listar coleções de host

GET /katello/api/organizations/:organization_id/host_collections
Listar coleções de host dentro de uma organização

GET /katello/api/activation_keys/:activation_key_id/host_collections
Listar Coleções de Host em uma Chave de Ativação

Parâmentros

Nome parâmetro Descrição
search
opcional

Buscar faixa

Validations:

  • String

page
opcional

Número de página, iniciando em 1

Validations:

  • number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • number.

order
opcional

Classificar campo e ordem, ex. 'name DESC'

Validations:

  • String

full_results
opcional

Se deve ou não exibir todos os resultados

Validations:

  • boolean

sort
opcional

Versão Hash de param de “ordem”

Validations:

  • Hash

sort[by]
opcional

Campo para classificar os resultados

Validations:

  • String

sort[order]
opcional

Como encomendar os resultados classificados (por exemplo ASC para ascendente)

Validations:

  • String

organization_id
opcional

identificador da organização

Validations:

  • number.

name
opcional

filtrar por nome de coleção de host

Validations:

  • String

activation_key_id
opcional

identificador da chave de ativação

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_id
opcional

Filtrar produtos por id de host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

available_for
opcional

Interpretar objetos especificados para retornar somente as Coleções de Hosts que podem ser associadas com os objetos especificados. Somente 'host' possui suporte.

Validations:

  • String


POST /katello/api/host_collections
Criar uma coleção de host

POST /katello/api/organizations/:organization_id/host_collections
Criar uma coleção de host

Parâmentros

Nome parâmetro Descrição
organization_id
requerido

identificador da organização

Validations:

  • number.

name
requerido

Nome da Coleção do host

Validations:

  • String

description
opcional

Validations:

  • String

host_ids
opcional

Lista de ids de host para substituir os hosts na coleção de hosts

Validations:

  • Must be an array of any type

max_hosts
opcional

Número máximo de hosts na coleção de hosts

Validations:

  • Integer

unlimited_hosts
opcional

Se a coleção de hosts pode possuir ou não hosts ilimitados

Validations:

  • boolean


PUT /katello/api/host_collections/:id
Atualizar uma coleção de host

Parâmentros

Nome parâmetro Descrição
id
requerido

ID da coleção do host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

name
opcional

Nome da Coleção do host

Validations:

  • String

description
opcional

Validations:

  • String

host_ids
opcional

Lista de ids de host para substituir os hosts na coleção de hosts

Validations:

  • Must be an array of any type

max_hosts
opcional

Número máximo de hosts na coleção de hosts

Validations:

  • Integer

unlimited_hosts
opcional

Se a coleção de hosts pode possuir ou não hosts ilimitados

Validations:

  • boolean


PUT /katello/api/host_collections/:id/add_hosts
Adicionar host à coleção de hosts

Parâmentros

Nome parâmetro Descrição
id
requerido

ID da coleção do host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_ids
opcional

Matriz de ids de host

Validations:

  • Must be an array of any type


PUT /katello/api/host_collections/:id/remove_hosts
Remover hosts da coleção de hosts

Parâmentros

Nome parâmetro Descrição
id
requerido

ID da coleção do host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_ids
opcional

Matriz de ids de host

Validations:

  • Must be an array of any type


DELETE /katello/api/host_collections/:id
Destruir uma coleção de host

Parâmentros

Nome parâmetro Descrição
id
requerido

ID da coleção do host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /katello/api/host_collections/:id/copy
Fazer uma cópia de uma coleção de host

Parâmentros

Nome parâmetro Descrição
id
requerido

ID da coleção do host

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

name
requerido

Novo nome de coleção de host

Validations:

  • String