Configs

>>>

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

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Integer
search
Optional

filtra els resultats

Validations:

  • String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String
page
Optional

pagina els resultats

Validations:

  • String
per_page
Optional

Nombre d'entrades per petició

Validations:

  • String
>>>

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

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Integer
id
Required

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

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Integer
id
Required

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

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Integer
foreman_virt_who_configure_config
Required

Validations:

  • Hash
foreman_virt_who_configure_config[name]
Required

Configuration name

Validations:

  • String
foreman_virt_who_configure_config[interval]
Required

Configuration interval in minutes

Validations:

  • Must be one of: 60, 120, 240, 480, 720, 1440, 2880, 4320.
foreman_virt_who_configure_config[filtering_mode]
Required

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]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Specifies how the hypervisor will be identified.

Validations:

  • Must be one of: hostname, uuid, hwuuid.
foreman_virt_who_configure_config[hypervisor_type]
Required

Hypervisor type

Validations:

  • Must be one of: esx, rhevm, hyperv, xen, libvirt, kubevirt.
foreman_virt_who_configure_config[hypervisor_server]
Required

Fully qualified host name or IP address of the hypervisor

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_username]
Required

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

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Hypervisor password, required for all hypervisor types except for libvirt

Validations:

  • String
foreman_virt_who_configure_config[satellite_url]
Required

Satellite server FQDN

Validations:

  • String
foreman_virt_who_configure_config[debug]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Enable debugging output

Validations:

  • Must be one of: true, false, 1, 0.
foreman_virt_who_configure_config[proxy]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Organization of the virt-who configuration

Validations:

  • Integer
>>>

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

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Integer
id
Required

Configuration numeric identifier

Validations:

  • Must be a number.
foreman_virt_who_configure_config
Required

Validations:

  • Hash
foreman_virt_who_configure_config[name]
Optional

Configuration name

Validations:

  • String
foreman_virt_who_configure_config[interval]
Optional

Configuration interval in minutes

Validations:

  • Must be one of: 60, 120, 240, 480, 720, 1440, 2880, 4320.
foreman_virt_who_configure_config[filtering_mode]
Optional

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]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Specifies how the hypervisor will be identified.

Validations:

  • Must be one of: hostname, uuid, hwuuid.
foreman_virt_who_configure_config[hypervisor_type]
Optional

Hypervisor type

Validations:

  • Must be one of: esx, rhevm, hyperv, xen, libvirt, kubevirt.
foreman_virt_who_configure_config[hypervisor_server]
Optional

Fully qualified host name or IP address of the hypervisor

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_username]
Optional

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

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Hypervisor password, required for all hypervisor types except for libvirt

Validations:

  • String
foreman_virt_who_configure_config[satellite_url]
Optional

Satellite server FQDN

Validations:

  • String
foreman_virt_who_configure_config[debug]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Enable debugging output

Validations:

  • Must be one of: true, false, 1, 0.
foreman_virt_who_configure_config[proxy]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Organization of the virt-who configuration

Validations:

  • Integer
>>>

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

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Integer
id
Required

Configuration numeric identifier

Validations:

  • Must be a number.