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

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

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

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

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

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

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 , nil allowed

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 , nil allowed

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[filter_host_parents]
optional , nil allowed

Applicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.

Validations:

  • String
foreman_virt_who_configure_config[exclude_host_parents]
optional , nil allowed

Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.

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, hyperv, libvirt, kubevirt, ahv.
foreman_virt_who_configure_config[hypervisor_server]
optional , nil allowed

Fully qualified host name or IP address of the hypervisor

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_username]
optional , nil allowed

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

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_password]
optional , nil allowed

Hypervisor password, required for all hypervisor types except for libvirt/kubevirt.

Validations:

  • String
foreman_virt_who_configure_config[satellite_url]
required

Foreman server FQDN

Validations:

  • String
foreman_virt_who_configure_config[debug]
optional , nil allowed

Enable debugging output

Validations:

  • Must be one of: true, false, 1, 0.
foreman_virt_who_configure_config[kubeconfig_path]
optional , nil allowed

Configuration file containing details about how to connect to the cluster and authentication details.

Validations:

  • String
foreman_virt_who_configure_config[http_proxy_id]
optional , nil allowed

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

Validations:

  • Integer
foreman_virt_who_configure_config[no_proxy]
optional , nil allowed

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
foreman_virt_who_configure_config[prism_flavor]
optional , nil allowed

Select the Prism flavor you are connecting to

Validations:

  • Must be one of: central, element.
foreman_virt_who_configure_config[ahv_internal_debug]
optional , nil allowed

Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled

Validations:

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

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

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 , nil allowed

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 , nil allowed

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[filter_host_parents]
optional , nil allowed

Applicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.

Validations:

  • String
foreman_virt_who_configure_config[exclude_host_parents]
optional , nil allowed

Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.

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, hyperv, libvirt, kubevirt, ahv.
foreman_virt_who_configure_config[hypervisor_server]
optional , nil allowed

Fully qualified host name or IP address of the hypervisor

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_username]
optional , nil allowed

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

Validations:

  • String
foreman_virt_who_configure_config[hypervisor_password]
optional , nil allowed

Hypervisor password, required for all hypervisor types except for libvirt/kubevirt.

Validations:

  • String
foreman_virt_who_configure_config[satellite_url]
optional

Foreman server FQDN

Validations:

  • String
foreman_virt_who_configure_config[debug]
optional , nil allowed

Enable debugging output

Validations:

  • Must be one of: true, false, 1, 0.
foreman_virt_who_configure_config[kubeconfig_path]
optional , nil allowed

Configuration file containing details about how to connect to the cluster and authentication details.

Validations:

  • String
foreman_virt_who_configure_config[http_proxy_id]
optional , nil allowed

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

Validations:

  • Integer
foreman_virt_who_configure_config[no_proxy]
optional , nil allowed

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
foreman_virt_who_configure_config[prism_flavor]
optional , nil allowed

Select the Prism flavor you are connecting to

Validations:

  • Must be one of: central, element.
foreman_virt_who_configure_config[ahv_internal_debug]
optional , nil allowed

Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled

Validations:

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

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Configuration numeric identifier

Validations:

  • Must be a number.