GET /foreman_virt_who_configure/api/v2/configs
List of virt-who configurations

GET /foreman_virt_who_configure/api/v2/organizations/:organization_id/configs
List of virt-who configurations per organization

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

search
optionel

filtrer les résultats

Validations:

  • String

order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • String

page
optionel

paginer les résultats

Validations:

  • String

per_page
optionel

nombre d'entrées par requête

Validations:

  • String


GET /foreman_virt_who_configure/api/v2/configs/:id
Show a virt-who configuration

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

Validations:

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


GET /foreman_virt_who_configure/api/v2/configs/:id/deploy_script
Renders a deploy script for the specified virt-who configuration

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

Validations:

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


POST /foreman_virt_who_configure/api/v2/configs
Create a virt-who configuration

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

foreman_virt_who_configure_config
requis

Validations:

  • Hash

foreman_virt_who_configure_config[name]
requis

Configuration name

Validations:

  • String

foreman_virt_who_configure_config[interval]
requis

Configuration interval in minutes

Validations:

  • Must be one of: 60, 120, 240, 480, 720, 1440, 2880, 4320.

foreman_virt_who_configure_config[filtering_mode]
requis

Hypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means blacklist

Validations:

  • Must be one of: 0, 1, 2.

foreman_virt_who_configure_config[whitelist]
optionel , nil autorisé

Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma.

Validations:

  • String

foreman_virt_who_configure_config[blacklist]
optionel , nil autorisé

Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma.

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_id]
requis

Specifies how the hypervisor will be identified.

Validations:

  • Must be one of: hostname, uuid, hwuuid.

foreman_virt_who_configure_config[hypervisor_type]
requis

Hypervisor type

Validations:

  • Must be one of: esx, rhevm, hyperv, xen, libvirt, kubevirt.

foreman_virt_who_configure_config[hypervisor_server]
requis

Fully qualified host name or IP address of the hypervisor

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_username]
requis

Account name by which virt-who is to connect to the hypervisor.

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_password]
optionel , nil autorisé

Hypervisor password, required for all hypervisor types except for libvirt

Validations:

  • String

foreman_virt_who_configure_config[satellite_url]
requis

Satellite server FQDN

Validations:

  • String

foreman_virt_who_configure_config[debug]
optionel , nil autorisé

Enable debugging output

Validations:

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

foreman_virt_who_configure_config[proxy]
optionel , nil autorisé

HTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.

Validations:

  • String

foreman_virt_who_configure_config[no_proxy]
optionel , nil autorisé

Ignore proxy. A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.

Validations:

  • String

foreman_virt_who_configure_config[organization_id]
requis

Organization of the virt-who configuration

Validations:

  • Integer


PUT /foreman_virt_who_configure/api/v2/configs/:id
Update a virt-who configuration

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

Configuration numeric identifier

Validations:

  • Must be a number.

foreman_virt_who_configure_config
requis

Validations:

  • Hash

foreman_virt_who_configure_config[name]
optionel

Configuration name

Validations:

  • String

foreman_virt_who_configure_config[interval]
optionel

Configuration interval in minutes

Validations:

  • Must be one of: 60, 120, 240, 480, 720, 1440, 2880, 4320.

foreman_virt_who_configure_config[filtering_mode]
optionel

Hypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means blacklist

Validations:

  • Must be one of: 0, 1, 2.

foreman_virt_who_configure_config[whitelist]
optionel , nil autorisé

Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma.

Validations:

  • String

foreman_virt_who_configure_config[blacklist]
optionel , nil autorisé

Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma.

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_id]
optionel

Specifies how the hypervisor will be identified.

Validations:

  • Must be one of: hostname, uuid, hwuuid.

foreman_virt_who_configure_config[hypervisor_type]
optionel

Hypervisor type

Validations:

  • Must be one of: esx, rhevm, hyperv, xen, libvirt, kubevirt.

foreman_virt_who_configure_config[hypervisor_server]
optionel

Fully qualified host name or IP address of the hypervisor

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_username]
optionel

Account name by which virt-who is to connect to the hypervisor.

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_password]
optionel , nil autorisé

Hypervisor password, required for all hypervisor types except for libvirt

Validations:

  • String

foreman_virt_who_configure_config[satellite_url]
optionel

Satellite server FQDN

Validations:

  • String

foreman_virt_who_configure_config[debug]
optionel , nil autorisé

Enable debugging output

Validations:

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

foreman_virt_who_configure_config[proxy]
optionel , nil autorisé

HTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.

Validations:

  • String

foreman_virt_who_configure_config[no_proxy]
optionel , nil autorisé

Ignore proxy. A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.

Validations:

  • String

foreman_virt_who_configure_config[organization_id]
optionel

Organization of the virt-who configuration

Validations:

  • Integer


DELETE /foreman_virt_who_configure/api/v2/configs/:id
Delete a virt-who configuration

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

Configuration numeric identifier

Validations:

  • Must be a number.