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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Integer

search
opcjonalny

rezultat filtrowania

Validations:

  • String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
opcjonalny

rezultat paginacji

Validations:

  • String

per_page
opcjonalny

Liczba wpisów na jedno żądanie

Validations:

  • String


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Integer

id
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Integer

id
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Integer

foreman_virt_who_configure_config
wymagany

Validations:

  • Hash

foreman_virt_who_configure_config[name]
wymagany

Configuration name

Validations:

  • String

foreman_virt_who_configure_config[interval]
wymagany

Configuration interval in minutes

Validations:

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

foreman_virt_who_configure_config[filtering_mode]
wymagany

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]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

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]
wymagany

Specifies how the hypervisor will be identified.

Validations:

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

foreman_virt_who_configure_config[hypervisor_type]
wymagany

Hypervisor type

Validations:

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

foreman_virt_who_configure_config[hypervisor_server]
wymagany

Fully qualified host name or IP address of the hypervisor

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_username]
wymagany

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

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_password]
opcjonalny , nil dopuszczalny

Hypervisor password, required for all hypervisor types except for libvirt

Validations:

  • String

foreman_virt_who_configure_config[satellite_url]
wymagany

Satellite server FQDN

Validations:

  • String

foreman_virt_who_configure_config[debug]
opcjonalny , nil dopuszczalny

Enable debugging output

Validations:

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

foreman_virt_who_configure_config[proxy]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

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]
wymagany

Organization of the virt-who configuration

Validations:

  • Integer


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Integer

id
wymagany

Configuration numeric identifier

Validations:

  • Must be a number.

foreman_virt_who_configure_config
wymagany

Validations:

  • Hash

foreman_virt_who_configure_config[name]
opcjonalny

Configuration name

Validations:

  • String

foreman_virt_who_configure_config[interval]
opcjonalny

Configuration interval in minutes

Validations:

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

foreman_virt_who_configure_config[filtering_mode]
opcjonalny

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]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

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]
opcjonalny

Specifies how the hypervisor will be identified.

Validations:

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

foreman_virt_who_configure_config[hypervisor_type]
opcjonalny

Hypervisor type

Validations:

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

foreman_virt_who_configure_config[hypervisor_server]
opcjonalny

Fully qualified host name or IP address of the hypervisor

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_username]
opcjonalny

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

Validations:

  • String

foreman_virt_who_configure_config[hypervisor_password]
opcjonalny , nil dopuszczalny

Hypervisor password, required for all hypervisor types except for libvirt

Validations:

  • String

foreman_virt_who_configure_config[satellite_url]
opcjonalny

Satellite server FQDN

Validations:

  • String

foreman_virt_who_configure_config[debug]
opcjonalny , nil dopuszczalny

Enable debugging output

Validations:

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

foreman_virt_who_configure_config[proxy]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

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]
opcjonalny

Organization of the virt-who configuration

Validations:

  • Integer


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Integer

id
wymagany

Configuration numeric identifier

Validations:

  • Must be a number.