GET /katello/api/host_collections/:id
Afficher une collection d'hôte

Paramètres

Nom du paramètre Description
id
requis

ID de la collection d'hôtes

Validations:

  • number.


GET /katello/api/host_collections
Répertorier les collections d'hôtes

GET /katello/api/organizations/:organization_id/host_collections
Énumérer les collections d'hôtes dans une organisation

GET /katello/api/activation_keys/:activation_key_id/host_collections
Énumérer les collections d'hôtes dans une clé d'activation

Paramètres

Nom du paramètre Description
search
optionel

Rechercher une chaîne

Validations:

  • String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • number.

order
optionel

Trier le champ et l'ordre, ex : 'name DESC'

Validations:

  • String

full_result
optionel

Afficher tous les résultats ou pas

Validations:

  • boolean

sort
optionel

Version Hash des paramètres d'« ordre »

Validations:

  • Hash

sort[by]
optionel

Champs dans lequel trier les résultats

Validations:

  • String

sort[order]
optionel

Comment classer les résultats triés (ex : ASC for ascending ou CRO pour croissant)

Validations:

  • String

organization_id
optionel

identifiant de l'organisation

Validations:

  • number.

name
optionel

nom de la collection d'hôte avec lequel filtrer

Validations:

  • String

activation_key_id
optionel

identifiant de la clé d'activation

Validations:

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

host_id
optionel

Filter products by host id

Validations:

  • number.

available_for
optionel

Interpret specified object to return only Host Collections that can be associated with specified object. The value 'host' is supported.

Validations:

  • String


POST /katello/api/host_collections
Créer une collection d'hôte

POST /katello/api/organizations/:organization_id/host_collections
Créer une collection d'hôte

Paramètres

Nom du paramètre Description
organization_id
requis

identifiant de l'organisation

Validations:

  • number.

name
requis

Nom de la collection d'hôtes

Validations:

  • String

description
optionel

Validations:

  • String

host_ids
optionel

List of host ids to replace the hosts in host collection

Validations:

  • Must be an array of any type

max_hosts
optionel

Maximum number of hosts in the host collection

Validations:

  • Integer

unlimited_hosts
optionel

Whether or not the host collection may have unlimited hosts

Validations:

  • boolean


PUT /katello/api/host_collections/:id
Mettre à jour une collection d'hôte

Paramètres

Nom du paramètre Description
id
requis

ID de la collection d'hôtes

Validations:

  • number.

name
optionel

Nom de la collection d'hôtes

Validations:

  • String

description
optionel

Validations:

  • String

host_ids
optionel

List of host ids to replace the hosts in host collection

Validations:

  • Must be an array of any type

max_hosts
optionel

Maximum number of hosts in the host collection

Validations:

  • Integer

unlimited_hosts
optionel

Whether or not the host collection may have unlimited hosts

Validations:

  • boolean


PUT /katello/api/host_collections/:id/add_hosts
Add host to the host collection

Paramètres

Nom du paramètre Description
id
requis

ID de la collection d'hôtes

Validations:

  • number.

host_ids
optionel

Array of host ids

Validations:

  • Must be an array of any type


PUT /katello/api/host_collections/:id/remove_hosts
Remove hosts from the host collection

Paramètres

Nom du paramètre Description
id
requis

ID de la collection d'hôtes

Validations:

  • number.

host_ids
optionel

Array of host ids

Validations:

  • Must be an array of any type


DELETE /katello/api/host_collections/:id
Détruire une collection d'hôtes

Paramètres

Nom du paramètre Description
id
requis

ID de la collection d'hôtes

Validations:

  • number.


POST /katello/api/host_collections/:id/copy
Faire une copie d'une collection d'hôte

Paramètres

Nom du paramètre Description
id
requis

ID de la collection d'hôtes

Validations:

  • number.

name
requis

Nouveau nom de la collection d'hôtes

Validations:

  • String