From 6fdf34c54a998a6ddd6a1febf56290ad4eedb57a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Gajdu=C5=A1ek?= Date: Fri, 15 Aug 2025 15:58:01 +0200 Subject: [PATCH] Add Foreman 3.16 apidocs --- foreman/3.16/apidoc/javascripts/apipie.js | 6 + .../javascripts/bundled/bootstrap-collapse.js | 138 + .../apidoc/javascripts/bundled/bootstrap.js | 1726 +++ .../3.16/apidoc/javascripts/bundled/jquery.js | 9404 +++++++++++++++++ .../apidoc/javascripts/bundled/prettify.js | 28 + .../3.16/apidoc/stylesheets/application.css | 7 + .../bundled/bootstrap-responsive.min.css | 12 + .../stylesheets/bundled/bootstrap.min.css | 689 ++ .../apidoc/stylesheets/bundled/prettify.css | 30 + foreman/3.16/apidoc/v2.html | 3481 ++++++ foreman/3.16/apidoc/v2/architectures.html | 690 ++ .../3.16/apidoc/v2/architectures/create.html | 165 + .../3.16/apidoc/v2/architectures/destroy.html | 111 + .../3.16/apidoc/v2/architectures/index.html | 257 + .../3.16/apidoc/v2/architectures/show.html | 111 + .../3.16/apidoc/v2/architectures/update.html | 191 + foreman/3.16/apidoc/v2/audits.html | 577 + foreman/3.16/apidoc/v2/audits/index.html | 431 + foreman/3.16/apidoc/v2/audits/show.html | 165 + .../3.16/apidoc/v2/auth_source_externals.html | 690 ++ .../v2/auth_source_externals/index.html | 310 + .../apidoc/v2/auth_source_externals/show.html | 165 + .../v2/auth_source_externals/update.html | 273 + .../3.16/apidoc/v2/auth_source_internals.html | 439 + .../v2/auth_source_internals/index.html | 296 + .../apidoc/v2/auth_source_internals/show.html | 165 + foreman/3.16/apidoc/v2/auth_source_ldaps.html | 2131 ++++ .../apidoc/v2/auth_source_ldaps/create.html | 742 ++ .../apidoc/v2/auth_source_ldaps/destroy.html | 165 + .../apidoc/v2/auth_source_ldaps/index.html | 310 + .../apidoc/v2/auth_source_ldaps/show.html | 165 + .../apidoc/v2/auth_source_ldaps/test.html | 165 + .../apidoc/v2/auth_source_ldaps/update.html | 768 ++ foreman/3.16/apidoc/v2/auth_sources.html | 336 + .../3.16/apidoc/v2/auth_sources/index.html | 310 + foreman/3.16/apidoc/v2/autosign.html | 409 + foreman/3.16/apidoc/v2/autosign/create.html | 167 + foreman/3.16/apidoc/v2/autosign/destroy.html | 167 + foreman/3.16/apidoc/v2/autosign/index.html | 139 + foreman/3.16/apidoc/v2/bookmarks.html | 1061 ++ foreman/3.16/apidoc/v2/bookmarks/create.html | 269 + foreman/3.16/apidoc/v2/bookmarks/destroy.html | 165 + foreman/3.16/apidoc/v2/bookmarks/index.html | 315 + foreman/3.16/apidoc/v2/bookmarks/show.html | 165 + foreman/3.16/apidoc/v2/bookmarks/update.html | 295 + foreman/3.16/apidoc/v2/common_parameters.html | 1137 ++ .../apidoc/v2/common_parameters/create.html | 271 + .../apidoc/v2/common_parameters/destroy.html | 165 + .../apidoc/v2/common_parameters/index.html | 359 + .../apidoc/v2/common_parameters/show.html | 193 + .../apidoc/v2/common_parameters/update.html | 297 + .../3.16/apidoc/v2/compute_attributes.html | 1047 ++ .../apidoc/v2/compute_attributes/create.html | 271 + .../apidoc/v2/compute_attributes/index.html | 370 + .../apidoc/v2/compute_attributes/show.html | 167 + .../apidoc/v2/compute_attributes/update.html | 297 + foreman/3.16/apidoc/v2/compute_profiles.html | 866 ++ .../apidoc/v2/compute_profiles/create.html | 191 + .../apidoc/v2/compute_profiles/destroy.html | 165 + .../apidoc/v2/compute_profiles/index.html | 276 + .../3.16/apidoc/v2/compute_profiles/show.html | 165 + .../apidoc/v2/compute_profiles/update.html | 217 + foreman/3.16/apidoc/v2/compute_resources.html | 4419 ++++++++ .../v2/compute_resources/associate.html | 191 + .../compute_resources/available_clusters.html | 165 + .../compute_resources/available_flavors.html | 165 + .../compute_resources/available_folders.html | 165 + .../compute_resources/available_images.html | 165 + .../compute_resources/available_networks.html | 198 + .../available_resource_pools.html | 191 + .../available_security_groups.html | 165 + .../available_storage_domains.html | 233 + .../available_storage_pods.html | 233 + .../available_virtual_machines.html | 165 + .../v2/compute_resources/available_zones.html | 165 + .../apidoc/v2/compute_resources/create.html | 665 ++ .../apidoc/v2/compute_resources/destroy.html | 165 + .../v2/compute_resources/destroy_vm.html | 191 + .../apidoc/v2/compute_resources/index.html | 301 + .../apidoc/v2/compute_resources/power_vm.html | 191 + .../v2/compute_resources/refresh_cache.html | 165 + .../apidoc/v2/compute_resources/show.html | 165 + .../apidoc/v2/compute_resources/show_vm.html | 191 + .../v2/compute_resources/storage_domain.html | 191 + .../v2/compute_resources/storage_pod.html | 191 + .../apidoc/v2/compute_resources/update.html | 691 ++ foreman/3.16/apidoc/v2/config_reports.html | 1094 ++ .../3.16/apidoc/v2/config_reports/create.html | 376 + .../apidoc/v2/config_reports/destroy.html | 165 + .../3.16/apidoc/v2/config_reports/index.html | 371 + .../3.16/apidoc/v2/config_reports/last.html | 165 + .../3.16/apidoc/v2/config_reports/show.html | 165 + foreman/3.16/apidoc/v2/dashboard.html | 187 + foreman/3.16/apidoc/v2/dashboard/index.html | 167 + foreman/3.16/apidoc/v2/domains.html | 1273 +++ foreman/3.16/apidoc/v2/domains/create.html | 335 + foreman/3.16/apidoc/v2/domains/destroy.html | 165 + foreman/3.16/apidoc/v2/domains/index.html | 355 + foreman/3.16/apidoc/v2/domains/show.html | 195 + foreman/3.16/apidoc/v2/domains/update.html | 359 + .../3.16/apidoc/v2/external_usergroups.html | 788 ++ .../apidoc/v2/external_usergroups/create.html | 197 + .../v2/external_usergroups/destroy.html | 141 + .../apidoc/v2/external_usergroups/index.html | 120 + .../v2/external_usergroups/refresh.html | 141 + .../apidoc/v2/external_usergroups/show.html | 148 + .../apidoc/v2/external_usergroups/update.html | 225 + foreman/3.16/apidoc/v2/fact_values.html | 376 + foreman/3.16/apidoc/v2/fact_values/index.html | 353 + foreman/3.16/apidoc/v2/filters.html | 1181 +++ foreman/3.16/apidoc/v2/filters/create.html | 321 + foreman/3.16/apidoc/v2/filters/destroy.html | 165 + foreman/3.16/apidoc/v2/filters/index.html | 331 + foreman/3.16/apidoc/v2/filters/show.html | 165 + foreman/3.16/apidoc/v2/filters/update.html | 347 + foreman/3.16/apidoc/v2/home.html | 256 + foreman/3.16/apidoc/v2/home/index.html | 139 + foreman/3.16/apidoc/v2/home/status.html | 139 + foreman/3.16/apidoc/v2/host_statuses.html | 215 + .../3.16/apidoc/v2/host_statuses/index.html | 195 + foreman/3.16/apidoc/v2/hostgroups.html | 2701 +++++ foreman/3.16/apidoc/v2/hostgroups/clone.html | 165 + foreman/3.16/apidoc/v2/hostgroups/create.html | 835 ++ .../3.16/apidoc/v2/hostgroups/destroy.html | 165 + foreman/3.16/apidoc/v2/hostgroups/index.html | 403 + .../apidoc/v2/hostgroups/rebuild_config.html | 221 + foreman/3.16/apidoc/v2/hostgroups/show.html | 277 + foreman/3.16/apidoc/v2/hostgroups/update.html | 861 ++ foreman/3.16/apidoc/v2/hosts.html | 6925 ++++++++++++ foreman/3.16/apidoc/v2/hosts/boot.html | 193 + foreman/3.16/apidoc/v2/hosts/create.html | 1877 ++++ foreman/3.16/apidoc/v2/hosts/destroy.html | 212 + .../3.16/apidoc/v2/hosts/disassociate.html | 165 + foreman/3.16/apidoc/v2/hosts/enc.html | 165 + foreman/3.16/apidoc/v2/hosts/facts.html | 251 + .../3.16/apidoc/v2/hosts/forget_status.html | 193 + foreman/3.16/apidoc/v2/hosts/get_status.html | 193 + foreman/3.16/apidoc/v2/hosts/index.html | 860 ++ .../apidoc/v2/hosts/inherited_parameters.html | 165 + foreman/3.16/apidoc/v2/hosts/power.html | 193 + .../3.16/apidoc/v2/hosts/power_status.html | 202 + .../3.16/apidoc/v2/hosts/rebuild_config.html | 193 + foreman/3.16/apidoc/v2/hosts/show.html | 348 + foreman/3.16/apidoc/v2/hosts/template.html | 193 + foreman/3.16/apidoc/v2/hosts/templates.html | 165 + foreman/3.16/apidoc/v2/hosts/update.html | 1875 ++++ .../v2/hosts/vm_compute_attributes.html | 167 + .../3.16/apidoc/v2/hosts_bulk_actions.html | 1945 ++++ .../hosts_bulk_actions/assign_location.html | 335 + .../assign_organization.html | 335 + .../apidoc/v2/hosts_bulk_actions/build.html | 335 + .../v2/hosts_bulk_actions/bulk_destroy.html | 279 + .../v2/hosts_bulk_actions/change_owner.html | 307 + .../v2/hosts_bulk_actions/disassociate.html | 279 + .../reassign_hostgroup.html | 307 + foreman/3.16/apidoc/v2/http_proxies.html | 1177 +++ .../3.16/apidoc/v2/http_proxies/create.html | 333 + .../3.16/apidoc/v2/http_proxies/destroy.html | 165 + .../3.16/apidoc/v2/http_proxies/index.html | 301 + foreman/3.16/apidoc/v2/http_proxies/show.html | 167 + .../3.16/apidoc/v2/http_proxies/update.html | 359 + foreman/3.16/apidoc/v2/images.html | 1561 +++ foreman/3.16/apidoc/v2/images/create.html | 409 + foreman/3.16/apidoc/v2/images/destroy.html | 191 + foreman/3.16/apidoc/v2/images/index.html | 399 + foreman/3.16/apidoc/v2/images/show.html | 263 + foreman/3.16/apidoc/v2/images/update.html | 435 + foreman/3.16/apidoc/v2/instance_hosts.html | 379 + .../apidoc/v2/instance_hosts/destroy.html | 139 + .../3.16/apidoc/v2/instance_hosts/index.html | 139 + .../3.16/apidoc/v2/instance_hosts/update.html | 165 + foreman/3.16/apidoc/v2/interfaces.html | 2247 ++++ foreman/3.16/apidoc/v2/interfaces/create.html | 839 ++ .../3.16/apidoc/v2/interfaces/destroy.html | 195 + foreman/3.16/apidoc/v2/interfaces/index.html | 293 + foreman/3.16/apidoc/v2/interfaces/show.html | 195 + foreman/3.16/apidoc/v2/interfaces/update.html | 867 ++ foreman/3.16/apidoc/v2/locations.html | 1764 ++++ foreman/3.16/apidoc/v2/locations/create.html | 609 ++ foreman/3.16/apidoc/v2/locations/destroy.html | 184 + foreman/3.16/apidoc/v2/locations/index.html | 291 + foreman/3.16/apidoc/v2/locations/show.html | 193 + foreman/3.16/apidoc/v2/locations/update.html | 635 ++ .../3.16/apidoc/v2/mail_notifications.html | 1169 ++ .../apidoc/v2/mail_notifications/create.html | 275 + .../apidoc/v2/mail_notifications/destroy.html | 191 + .../apidoc/v2/mail_notifications/index.html | 286 + .../apidoc/v2/mail_notifications/show.html | 167 + .../apidoc/v2/mail_notifications/update.html | 275 + .../user_mail_notifications.html | 165 + foreman/3.16/apidoc/v2/media.html | 1242 +++ foreman/3.16/apidoc/v2/media/create.html | 335 + foreman/3.16/apidoc/v2/media/destroy.html | 165 + foreman/3.16/apidoc/v2/media/index.html | 355 + foreman/3.16/apidoc/v2/media/show.html | 165 + foreman/3.16/apidoc/v2/media/update.html | 361 + foreman/3.16/apidoc/v2/models.html | 1079 ++ foreman/3.16/apidoc/v2/models/create.html | 269 + foreman/3.16/apidoc/v2/models/destroy.html | 165 + foreman/3.16/apidoc/v2/models/index.html | 333 + foreman/3.16/apidoc/v2/models/show.html | 165 + foreman/3.16/apidoc/v2/models/update.html | 295 + foreman/3.16/apidoc/v2/operatingsystems.html | 2059 ++++ .../apidoc/v2/operatingsystems/bootfiles.html | 218 + .../apidoc/v2/operatingsystems/create.html | 545 + .../apidoc/v2/operatingsystems/destroy.html | 165 + .../apidoc/v2/operatingsystems/index.html | 545 + .../3.16/apidoc/v2/operatingsystems/show.html | 193 + .../apidoc/v2/operatingsystems/update.html | 571 + foreman/3.16/apidoc/v2/organizations.html | 1764 ++++ .../3.16/apidoc/v2/organizations/create.html | 609 ++ .../3.16/apidoc/v2/organizations/destroy.html | 184 + .../3.16/apidoc/v2/organizations/index.html | 291 + .../3.16/apidoc/v2/organizations/show.html | 193 + .../3.16/apidoc/v2/organizations/update.html | 635 ++ .../3.16/apidoc/v2/os_default_templates.html | 1019 ++ .../v2/os_default_templates/create.html | 247 + .../v2/os_default_templates/destroy.html | 193 + .../apidoc/v2/os_default_templates/index.html | 258 + .../apidoc/v2/os_default_templates/show.html | 193 + .../v2/os_default_templates/update.html | 273 + foreman/3.16/apidoc/v2/parameters.html | 2447 +++++ foreman/3.16/apidoc/v2/parameters/create.html | 455 + .../3.16/apidoc/v2/parameters/destroy.html | 349 + foreman/3.16/apidoc/v2/parameters/index.html | 541 + foreman/3.16/apidoc/v2/parameters/reset.html | 321 + foreman/3.16/apidoc/v2/parameters/show.html | 377 + foreman/3.16/apidoc/v2/parameters/update.html | 483 + foreman/3.16/apidoc/v2/permissions.html | 618 ++ .../v2/permissions/current_permissions.html | 139 + foreman/3.16/apidoc/v2/permissions/index.html | 281 + .../apidoc/v2/permissions/resource_types.html | 139 + foreman/3.16/apidoc/v2/permissions/show.html | 165 + .../apidoc/v2/personal_access_tokens.html | 851 ++ .../v2/personal_access_tokens/create.html | 247 + .../v2/personal_access_tokens/destroy.html | 193 + .../v2/personal_access_tokens/index.html | 324 + .../v2/personal_access_tokens/show.html | 193 + foreman/3.16/apidoc/v2/ping.html | 260 + foreman/3.16/apidoc/v2/ping/ping.html | 141 + foreman/3.16/apidoc/v2/ping/statuses.html | 141 + foreman/3.16/apidoc/v2/plugins.html | 159 + foreman/3.16/apidoc/v2/plugins/index.html | 139 + .../apidoc/v2/provisioning_templates.html | 2427 +++++ .../build_pxe_default.html | 139 + .../v2/provisioning_templates/clone.html | 219 + .../v2/provisioning_templates/create.html | 465 + .../v2/provisioning_templates/destroy.html | 165 + .../v2/provisioning_templates/export.html | 165 + .../v2/provisioning_templates/import.html | 415 + .../v2/provisioning_templates/index.html | 385 + .../v2/provisioning_templates/revision.html | 167 + .../v2/provisioning_templates/show.html | 165 + .../v2/provisioning_templates/update.html | 491 + foreman/3.16/apidoc/v2/ptables.html | 2373 +++++ foreman/3.16/apidoc/v2/ptables/clone.html | 219 + foreman/3.16/apidoc/v2/ptables/create.html | 489 + foreman/3.16/apidoc/v2/ptables/destroy.html | 165 + foreman/3.16/apidoc/v2/ptables/export.html | 165 + foreman/3.16/apidoc/v2/ptables/import.html | 415 + foreman/3.16/apidoc/v2/ptables/index.html | 380 + foreman/3.16/apidoc/v2/ptables/revision.html | 167 + foreman/3.16/apidoc/v2/ptables/show.html | 165 + foreman/3.16/apidoc/v2/ptables/update.html | 515 + foreman/3.16/apidoc/v2/realms.html | 1123 ++ foreman/3.16/apidoc/v2/realms/create.html | 307 + foreman/3.16/apidoc/v2/realms/destroy.html | 165 + foreman/3.16/apidoc/v2/realms/index.html | 301 + foreman/3.16/apidoc/v2/realms/show.html | 167 + foreman/3.16/apidoc/v2/realms/update.html | 331 + foreman/3.16/apidoc/v2/registration.html | 2006 ++++ .../3.16/apidoc/v2/registration/global.html | 589 ++ foreman/3.16/apidoc/v2/registration/host.html | 1439 +++ .../3.16/apidoc/v2/registration_commands.html | 663 ++ .../v2/registration_commands/create.html | 643 ++ .../3.16/apidoc/v2/registration_tokens.html | 316 + .../registration_tokens/invalidate_jwt.html | 169 + .../invalidate_jwt_tokens.html | 169 + foreman/3.16/apidoc/v2/report_templates.html | 2789 +++++ .../apidoc/v2/report_templates/clone.html | 219 + .../apidoc/v2/report_templates/create.html | 407 + .../apidoc/v2/report_templates/destroy.html | 165 + .../apidoc/v2/report_templates/export.html | 165 + .../apidoc/v2/report_templates/generate.html | 249 + .../apidoc/v2/report_templates/import.html | 415 + .../apidoc/v2/report_templates/index.html | 330 + .../v2/report_templates/report_data.html | 195 + .../apidoc/v2/report_templates/revision.html | 167 + .../v2/report_templates/schedule_report.html | 315 + .../3.16/apidoc/v2/report_templates/show.html | 165 + .../apidoc/v2/report_templates/update.html | 433 + foreman/3.16/apidoc/v2/roles.html | 1339 +++ foreman/3.16/apidoc/v2/roles/clone.html | 301 + foreman/3.16/apidoc/v2/roles/create.html | 275 + foreman/3.16/apidoc/v2/roles/destroy.html | 165 + foreman/3.16/apidoc/v2/roles/index.html | 296 + foreman/3.16/apidoc/v2/roles/show.html | 191 + foreman/3.16/apidoc/v2/roles/update.html | 301 + foreman/3.16/apidoc/v2/settings.html | 476 + foreman/3.16/apidoc/v2/settings/index.html | 227 + foreman/3.16/apidoc/v2/settings/show.html | 111 + foreman/3.16/apidoc/v2/settings/update.html | 202 + foreman/3.16/apidoc/v2/smart_proxies.html | 1390 +++ .../3.16/apidoc/v2/smart_proxies/create.html | 273 + .../3.16/apidoc/v2/smart_proxies/destroy.html | 165 + .../v2/smart_proxies/import_subnets.html | 165 + .../3.16/apidoc/v2/smart_proxies/index.html | 334 + .../3.16/apidoc/v2/smart_proxies/refresh.html | 165 + .../3.16/apidoc/v2/smart_proxies/show.html | 221 + .../3.16/apidoc/v2/smart_proxies/update.html | 299 + foreman/3.16/apidoc/v2/smart_proxy_hosts.html | 405 + .../apidoc/v2/smart_proxy_hosts/destroy.html | 139 + .../apidoc/v2/smart_proxy_hosts/index.html | 139 + .../apidoc/v2/smart_proxy_hosts/update.html | 191 + foreman/3.16/apidoc/v2/ssh_keys.html | 836 ++ foreman/3.16/apidoc/v2/ssh_keys/create.html | 247 + foreman/3.16/apidoc/v2/ssh_keys/destroy.html | 193 + foreman/3.16/apidoc/v2/ssh_keys/index.html | 309 + foreman/3.16/apidoc/v2/ssh_keys/show.html | 193 + foreman/3.16/apidoc/v2/subnets.html | 2680 +++++ foreman/3.16/apidoc/v2/subnets/create.html | 921 ++ foreman/3.16/apidoc/v2/subnets/destroy.html | 167 + foreman/3.16/apidoc/v2/subnets/freeip.html | 221 + foreman/3.16/apidoc/v2/subnets/index.html | 410 + foreman/3.16/apidoc/v2/subnets/show.html | 193 + foreman/3.16/apidoc/v2/subnets/update.html | 949 ++ foreman/3.16/apidoc/v2/table_preferences.html | 967 ++ .../apidoc/v2/table_preferences/create.html | 223 + .../apidoc/v2/table_preferences/destroy.html | 195 + .../apidoc/v2/table_preferences/index.html | 279 + .../apidoc/v2/table_preferences/show.html | 195 + .../apidoc/v2/table_preferences/update.html | 223 + foreman/3.16/apidoc/v2/tasks.html | 159 + foreman/3.16/apidoc/v2/tasks/index.html | 139 + .../3.16/apidoc/v2/template_combinations.html | 1007 ++ .../v2/template_combinations/create.html | 256 + .../v2/template_combinations/destroy.html | 165 + .../v2/template_combinations/index.html | 202 + .../apidoc/v2/template_combinations/show.html | 235 + .../v2/template_combinations/update.html | 282 + foreman/3.16/apidoc/v2/template_inputs.html | 1621 +++ .../apidoc/v2/template_inputs/create.html | 527 + .../apidoc/v2/template_inputs/destroy.html | 191 + .../3.16/apidoc/v2/template_inputs/index.html | 307 + .../3.16/apidoc/v2/template_inputs/show.html | 191 + .../apidoc/v2/template_inputs/update.html | 553 + foreman/3.16/apidoc/v2/template_kinds.html | 296 + .../3.16/apidoc/v2/template_kinds/index.html | 276 + foreman/3.16/apidoc/v2/usergroups.html | 820 ++ foreman/3.16/apidoc/v2/usergroups/create.html | 243 + .../3.16/apidoc/v2/usergroups/destroy.html | 111 + foreman/3.16/apidoc/v2/usergroups/index.html | 232 + foreman/3.16/apidoc/v2/usergroups/show.html | 111 + foreman/3.16/apidoc/v2/usergroups/update.html | 271 + foreman/3.16/apidoc/v2/users.html | 2176 ++++ foreman/3.16/apidoc/v2/users/create.html | 623 ++ foreman/3.16/apidoc/v2/users/destroy.html | 165 + foreman/3.16/apidoc/v2/users/extlogin.html | 139 + foreman/3.16/apidoc/v2/users/index.html | 482 + foreman/3.16/apidoc/v2/users/show.html | 165 + .../3.16/apidoc/v2/users/show_current.html | 139 + foreman/3.16/apidoc/v2/users/update.html | 677 ++ foreman/3.16/index.html | 6 + foreman/latest | 2 +- index.html | 1 + 365 files changed, 176649 insertions(+), 1 deletion(-) create mode 100644 foreman/3.16/apidoc/javascripts/apipie.js create mode 100644 foreman/3.16/apidoc/javascripts/bundled/bootstrap-collapse.js create mode 100644 foreman/3.16/apidoc/javascripts/bundled/bootstrap.js create mode 100644 foreman/3.16/apidoc/javascripts/bundled/jquery.js create mode 100644 foreman/3.16/apidoc/javascripts/bundled/prettify.js create mode 100644 foreman/3.16/apidoc/stylesheets/application.css create mode 100644 foreman/3.16/apidoc/stylesheets/bundled/bootstrap-responsive.min.css create mode 100644 foreman/3.16/apidoc/stylesheets/bundled/bootstrap.min.css create mode 100644 foreman/3.16/apidoc/stylesheets/bundled/prettify.css create mode 100644 foreman/3.16/apidoc/v2.html create mode 100644 foreman/3.16/apidoc/v2/architectures.html create mode 100644 foreman/3.16/apidoc/v2/architectures/create.html create mode 100644 foreman/3.16/apidoc/v2/architectures/destroy.html create mode 100644 foreman/3.16/apidoc/v2/architectures/index.html create mode 100644 foreman/3.16/apidoc/v2/architectures/show.html create mode 100644 foreman/3.16/apidoc/v2/architectures/update.html create mode 100644 foreman/3.16/apidoc/v2/audits.html create mode 100644 foreman/3.16/apidoc/v2/audits/index.html create mode 100644 foreman/3.16/apidoc/v2/audits/show.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_externals.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_externals/index.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_externals/show.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_externals/update.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_internals.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_internals/index.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_internals/show.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps/create.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps/destroy.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps/index.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps/show.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps/test.html create mode 100644 foreman/3.16/apidoc/v2/auth_source_ldaps/update.html create mode 100644 foreman/3.16/apidoc/v2/auth_sources.html create mode 100644 foreman/3.16/apidoc/v2/auth_sources/index.html create mode 100644 foreman/3.16/apidoc/v2/autosign.html create mode 100644 foreman/3.16/apidoc/v2/autosign/create.html create mode 100644 foreman/3.16/apidoc/v2/autosign/destroy.html create mode 100644 foreman/3.16/apidoc/v2/autosign/index.html create mode 100644 foreman/3.16/apidoc/v2/bookmarks.html create mode 100644 foreman/3.16/apidoc/v2/bookmarks/create.html create mode 100644 foreman/3.16/apidoc/v2/bookmarks/destroy.html create mode 100644 foreman/3.16/apidoc/v2/bookmarks/index.html create mode 100644 foreman/3.16/apidoc/v2/bookmarks/show.html create mode 100644 foreman/3.16/apidoc/v2/bookmarks/update.html create mode 100644 foreman/3.16/apidoc/v2/common_parameters.html create mode 100644 foreman/3.16/apidoc/v2/common_parameters/create.html create mode 100644 foreman/3.16/apidoc/v2/common_parameters/destroy.html create mode 100644 foreman/3.16/apidoc/v2/common_parameters/index.html create mode 100644 foreman/3.16/apidoc/v2/common_parameters/show.html create mode 100644 foreman/3.16/apidoc/v2/common_parameters/update.html create mode 100644 foreman/3.16/apidoc/v2/compute_attributes.html create mode 100644 foreman/3.16/apidoc/v2/compute_attributes/create.html create mode 100644 foreman/3.16/apidoc/v2/compute_attributes/index.html create mode 100644 foreman/3.16/apidoc/v2/compute_attributes/show.html create mode 100644 foreman/3.16/apidoc/v2/compute_attributes/update.html create mode 100644 foreman/3.16/apidoc/v2/compute_profiles.html create mode 100644 foreman/3.16/apidoc/v2/compute_profiles/create.html create mode 100644 foreman/3.16/apidoc/v2/compute_profiles/destroy.html create mode 100644 foreman/3.16/apidoc/v2/compute_profiles/index.html create mode 100644 foreman/3.16/apidoc/v2/compute_profiles/show.html create mode 100644 foreman/3.16/apidoc/v2/compute_profiles/update.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/associate.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_clusters.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_flavors.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_folders.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_images.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_networks.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_resource_pools.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_security_groups.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_storage_domains.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_storage_pods.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_virtual_machines.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/available_zones.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/create.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/destroy.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/destroy_vm.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/index.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/power_vm.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/refresh_cache.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/show.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/show_vm.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/storage_domain.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/storage_pod.html create mode 100644 foreman/3.16/apidoc/v2/compute_resources/update.html create mode 100644 foreman/3.16/apidoc/v2/config_reports.html create mode 100644 foreman/3.16/apidoc/v2/config_reports/create.html create mode 100644 foreman/3.16/apidoc/v2/config_reports/destroy.html create mode 100644 foreman/3.16/apidoc/v2/config_reports/index.html create mode 100644 foreman/3.16/apidoc/v2/config_reports/last.html create mode 100644 foreman/3.16/apidoc/v2/config_reports/show.html create mode 100644 foreman/3.16/apidoc/v2/dashboard.html create mode 100644 foreman/3.16/apidoc/v2/dashboard/index.html create mode 100644 foreman/3.16/apidoc/v2/domains.html create mode 100644 foreman/3.16/apidoc/v2/domains/create.html create mode 100644 foreman/3.16/apidoc/v2/domains/destroy.html create mode 100644 foreman/3.16/apidoc/v2/domains/index.html create mode 100644 foreman/3.16/apidoc/v2/domains/show.html create mode 100644 foreman/3.16/apidoc/v2/domains/update.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups/create.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups/destroy.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups/index.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups/refresh.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups/show.html create mode 100644 foreman/3.16/apidoc/v2/external_usergroups/update.html create mode 100644 foreman/3.16/apidoc/v2/fact_values.html create mode 100644 foreman/3.16/apidoc/v2/fact_values/index.html create mode 100644 foreman/3.16/apidoc/v2/filters.html create mode 100644 foreman/3.16/apidoc/v2/filters/create.html create mode 100644 foreman/3.16/apidoc/v2/filters/destroy.html create mode 100644 foreman/3.16/apidoc/v2/filters/index.html create mode 100644 foreman/3.16/apidoc/v2/filters/show.html create mode 100644 foreman/3.16/apidoc/v2/filters/update.html create mode 100644 foreman/3.16/apidoc/v2/home.html create mode 100644 foreman/3.16/apidoc/v2/home/index.html create mode 100644 foreman/3.16/apidoc/v2/home/status.html create mode 100644 foreman/3.16/apidoc/v2/host_statuses.html create mode 100644 foreman/3.16/apidoc/v2/host_statuses/index.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/clone.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/create.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/destroy.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/index.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/rebuild_config.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/show.html create mode 100644 foreman/3.16/apidoc/v2/hostgroups/update.html create mode 100644 foreman/3.16/apidoc/v2/hosts.html create mode 100644 foreman/3.16/apidoc/v2/hosts/boot.html create mode 100644 foreman/3.16/apidoc/v2/hosts/create.html create mode 100644 foreman/3.16/apidoc/v2/hosts/destroy.html create mode 100644 foreman/3.16/apidoc/v2/hosts/disassociate.html create mode 100644 foreman/3.16/apidoc/v2/hosts/enc.html create mode 100644 foreman/3.16/apidoc/v2/hosts/facts.html create mode 100644 foreman/3.16/apidoc/v2/hosts/forget_status.html create mode 100644 foreman/3.16/apidoc/v2/hosts/get_status.html create mode 100644 foreman/3.16/apidoc/v2/hosts/index.html create mode 100644 foreman/3.16/apidoc/v2/hosts/inherited_parameters.html create mode 100644 foreman/3.16/apidoc/v2/hosts/power.html create mode 100644 foreman/3.16/apidoc/v2/hosts/power_status.html create mode 100644 foreman/3.16/apidoc/v2/hosts/rebuild_config.html create mode 100644 foreman/3.16/apidoc/v2/hosts/show.html create mode 100644 foreman/3.16/apidoc/v2/hosts/template.html create mode 100644 foreman/3.16/apidoc/v2/hosts/templates.html create mode 100644 foreman/3.16/apidoc/v2/hosts/update.html create mode 100644 foreman/3.16/apidoc/v2/hosts/vm_compute_attributes.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_location.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_organization.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/build.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/bulk_destroy.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/change_owner.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/disassociate.html create mode 100644 foreman/3.16/apidoc/v2/hosts_bulk_actions/reassign_hostgroup.html create mode 100644 foreman/3.16/apidoc/v2/http_proxies.html create mode 100644 foreman/3.16/apidoc/v2/http_proxies/create.html create mode 100644 foreman/3.16/apidoc/v2/http_proxies/destroy.html create mode 100644 foreman/3.16/apidoc/v2/http_proxies/index.html create mode 100644 foreman/3.16/apidoc/v2/http_proxies/show.html create mode 100644 foreman/3.16/apidoc/v2/http_proxies/update.html create mode 100644 foreman/3.16/apidoc/v2/images.html create mode 100644 foreman/3.16/apidoc/v2/images/create.html create mode 100644 foreman/3.16/apidoc/v2/images/destroy.html create mode 100644 foreman/3.16/apidoc/v2/images/index.html create mode 100644 foreman/3.16/apidoc/v2/images/show.html create mode 100644 foreman/3.16/apidoc/v2/images/update.html create mode 100644 foreman/3.16/apidoc/v2/instance_hosts.html create mode 100644 foreman/3.16/apidoc/v2/instance_hosts/destroy.html create mode 100644 foreman/3.16/apidoc/v2/instance_hosts/index.html create mode 100644 foreman/3.16/apidoc/v2/instance_hosts/update.html create mode 100644 foreman/3.16/apidoc/v2/interfaces.html create mode 100644 foreman/3.16/apidoc/v2/interfaces/create.html create mode 100644 foreman/3.16/apidoc/v2/interfaces/destroy.html create mode 100644 foreman/3.16/apidoc/v2/interfaces/index.html create mode 100644 foreman/3.16/apidoc/v2/interfaces/show.html create mode 100644 foreman/3.16/apidoc/v2/interfaces/update.html create mode 100644 foreman/3.16/apidoc/v2/locations.html create mode 100644 foreman/3.16/apidoc/v2/locations/create.html create mode 100644 foreman/3.16/apidoc/v2/locations/destroy.html create mode 100644 foreman/3.16/apidoc/v2/locations/index.html create mode 100644 foreman/3.16/apidoc/v2/locations/show.html create mode 100644 foreman/3.16/apidoc/v2/locations/update.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications/create.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications/destroy.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications/index.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications/show.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications/update.html create mode 100644 foreman/3.16/apidoc/v2/mail_notifications/user_mail_notifications.html create mode 100644 foreman/3.16/apidoc/v2/media.html create mode 100644 foreman/3.16/apidoc/v2/media/create.html create mode 100644 foreman/3.16/apidoc/v2/media/destroy.html create mode 100644 foreman/3.16/apidoc/v2/media/index.html create mode 100644 foreman/3.16/apidoc/v2/media/show.html create mode 100644 foreman/3.16/apidoc/v2/media/update.html create mode 100644 foreman/3.16/apidoc/v2/models.html create mode 100644 foreman/3.16/apidoc/v2/models/create.html create mode 100644 foreman/3.16/apidoc/v2/models/destroy.html create mode 100644 foreman/3.16/apidoc/v2/models/index.html create mode 100644 foreman/3.16/apidoc/v2/models/show.html create mode 100644 foreman/3.16/apidoc/v2/models/update.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems/bootfiles.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems/create.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems/destroy.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems/index.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems/show.html create mode 100644 foreman/3.16/apidoc/v2/operatingsystems/update.html create mode 100644 foreman/3.16/apidoc/v2/organizations.html create mode 100644 foreman/3.16/apidoc/v2/organizations/create.html create mode 100644 foreman/3.16/apidoc/v2/organizations/destroy.html create mode 100644 foreman/3.16/apidoc/v2/organizations/index.html create mode 100644 foreman/3.16/apidoc/v2/organizations/show.html create mode 100644 foreman/3.16/apidoc/v2/organizations/update.html create mode 100644 foreman/3.16/apidoc/v2/os_default_templates.html create mode 100644 foreman/3.16/apidoc/v2/os_default_templates/create.html create mode 100644 foreman/3.16/apidoc/v2/os_default_templates/destroy.html create mode 100644 foreman/3.16/apidoc/v2/os_default_templates/index.html create mode 100644 foreman/3.16/apidoc/v2/os_default_templates/show.html create mode 100644 foreman/3.16/apidoc/v2/os_default_templates/update.html create mode 100644 foreman/3.16/apidoc/v2/parameters.html create mode 100644 foreman/3.16/apidoc/v2/parameters/create.html create mode 100644 foreman/3.16/apidoc/v2/parameters/destroy.html create mode 100644 foreman/3.16/apidoc/v2/parameters/index.html create mode 100644 foreman/3.16/apidoc/v2/parameters/reset.html create mode 100644 foreman/3.16/apidoc/v2/parameters/show.html create mode 100644 foreman/3.16/apidoc/v2/parameters/update.html create mode 100644 foreman/3.16/apidoc/v2/permissions.html create mode 100644 foreman/3.16/apidoc/v2/permissions/current_permissions.html create mode 100644 foreman/3.16/apidoc/v2/permissions/index.html create mode 100644 foreman/3.16/apidoc/v2/permissions/resource_types.html create mode 100644 foreman/3.16/apidoc/v2/permissions/show.html create mode 100644 foreman/3.16/apidoc/v2/personal_access_tokens.html create mode 100644 foreman/3.16/apidoc/v2/personal_access_tokens/create.html create mode 100644 foreman/3.16/apidoc/v2/personal_access_tokens/destroy.html create mode 100644 foreman/3.16/apidoc/v2/personal_access_tokens/index.html create mode 100644 foreman/3.16/apidoc/v2/personal_access_tokens/show.html create mode 100644 foreman/3.16/apidoc/v2/ping.html create mode 100644 foreman/3.16/apidoc/v2/ping/ping.html create mode 100644 foreman/3.16/apidoc/v2/ping/statuses.html create mode 100644 foreman/3.16/apidoc/v2/plugins.html create mode 100644 foreman/3.16/apidoc/v2/plugins/index.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/build_pxe_default.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/clone.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/create.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/destroy.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/export.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/import.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/index.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/revision.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/show.html create mode 100644 foreman/3.16/apidoc/v2/provisioning_templates/update.html create mode 100644 foreman/3.16/apidoc/v2/ptables.html create mode 100644 foreman/3.16/apidoc/v2/ptables/clone.html create mode 100644 foreman/3.16/apidoc/v2/ptables/create.html create mode 100644 foreman/3.16/apidoc/v2/ptables/destroy.html create mode 100644 foreman/3.16/apidoc/v2/ptables/export.html create mode 100644 foreman/3.16/apidoc/v2/ptables/import.html create mode 100644 foreman/3.16/apidoc/v2/ptables/index.html create mode 100644 foreman/3.16/apidoc/v2/ptables/revision.html create mode 100644 foreman/3.16/apidoc/v2/ptables/show.html create mode 100644 foreman/3.16/apidoc/v2/ptables/update.html create mode 100644 foreman/3.16/apidoc/v2/realms.html create mode 100644 foreman/3.16/apidoc/v2/realms/create.html create mode 100644 foreman/3.16/apidoc/v2/realms/destroy.html create mode 100644 foreman/3.16/apidoc/v2/realms/index.html create mode 100644 foreman/3.16/apidoc/v2/realms/show.html create mode 100644 foreman/3.16/apidoc/v2/realms/update.html create mode 100644 foreman/3.16/apidoc/v2/registration.html create mode 100644 foreman/3.16/apidoc/v2/registration/global.html create mode 100644 foreman/3.16/apidoc/v2/registration/host.html create mode 100644 foreman/3.16/apidoc/v2/registration_commands.html create mode 100644 foreman/3.16/apidoc/v2/registration_commands/create.html create mode 100644 foreman/3.16/apidoc/v2/registration_tokens.html create mode 100644 foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt.html create mode 100644 foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt_tokens.html create mode 100644 foreman/3.16/apidoc/v2/report_templates.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/clone.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/create.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/destroy.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/export.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/generate.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/import.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/index.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/report_data.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/revision.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/schedule_report.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/show.html create mode 100644 foreman/3.16/apidoc/v2/report_templates/update.html create mode 100644 foreman/3.16/apidoc/v2/roles.html create mode 100644 foreman/3.16/apidoc/v2/roles/clone.html create mode 100644 foreman/3.16/apidoc/v2/roles/create.html create mode 100644 foreman/3.16/apidoc/v2/roles/destroy.html create mode 100644 foreman/3.16/apidoc/v2/roles/index.html create mode 100644 foreman/3.16/apidoc/v2/roles/show.html create mode 100644 foreman/3.16/apidoc/v2/roles/update.html create mode 100644 foreman/3.16/apidoc/v2/settings.html create mode 100644 foreman/3.16/apidoc/v2/settings/index.html create mode 100644 foreman/3.16/apidoc/v2/settings/show.html create mode 100644 foreman/3.16/apidoc/v2/settings/update.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/create.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/destroy.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/import_subnets.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/index.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/refresh.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/show.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxies/update.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxy_hosts.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxy_hosts/destroy.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxy_hosts/index.html create mode 100644 foreman/3.16/apidoc/v2/smart_proxy_hosts/update.html create mode 100644 foreman/3.16/apidoc/v2/ssh_keys.html create mode 100644 foreman/3.16/apidoc/v2/ssh_keys/create.html create mode 100644 foreman/3.16/apidoc/v2/ssh_keys/destroy.html create mode 100644 foreman/3.16/apidoc/v2/ssh_keys/index.html create mode 100644 foreman/3.16/apidoc/v2/ssh_keys/show.html create mode 100644 foreman/3.16/apidoc/v2/subnets.html create mode 100644 foreman/3.16/apidoc/v2/subnets/create.html create mode 100644 foreman/3.16/apidoc/v2/subnets/destroy.html create mode 100644 foreman/3.16/apidoc/v2/subnets/freeip.html create mode 100644 foreman/3.16/apidoc/v2/subnets/index.html create mode 100644 foreman/3.16/apidoc/v2/subnets/show.html create mode 100644 foreman/3.16/apidoc/v2/subnets/update.html create mode 100644 foreman/3.16/apidoc/v2/table_preferences.html create mode 100644 foreman/3.16/apidoc/v2/table_preferences/create.html create mode 100644 foreman/3.16/apidoc/v2/table_preferences/destroy.html create mode 100644 foreman/3.16/apidoc/v2/table_preferences/index.html create mode 100644 foreman/3.16/apidoc/v2/table_preferences/show.html create mode 100644 foreman/3.16/apidoc/v2/table_preferences/update.html create mode 100644 foreman/3.16/apidoc/v2/tasks.html create mode 100644 foreman/3.16/apidoc/v2/tasks/index.html create mode 100644 foreman/3.16/apidoc/v2/template_combinations.html create mode 100644 foreman/3.16/apidoc/v2/template_combinations/create.html create mode 100644 foreman/3.16/apidoc/v2/template_combinations/destroy.html create mode 100644 foreman/3.16/apidoc/v2/template_combinations/index.html create mode 100644 foreman/3.16/apidoc/v2/template_combinations/show.html create mode 100644 foreman/3.16/apidoc/v2/template_combinations/update.html create mode 100644 foreman/3.16/apidoc/v2/template_inputs.html create mode 100644 foreman/3.16/apidoc/v2/template_inputs/create.html create mode 100644 foreman/3.16/apidoc/v2/template_inputs/destroy.html create mode 100644 foreman/3.16/apidoc/v2/template_inputs/index.html create mode 100644 foreman/3.16/apidoc/v2/template_inputs/show.html create mode 100644 foreman/3.16/apidoc/v2/template_inputs/update.html create mode 100644 foreman/3.16/apidoc/v2/template_kinds.html create mode 100644 foreman/3.16/apidoc/v2/template_kinds/index.html create mode 100644 foreman/3.16/apidoc/v2/usergroups.html create mode 100644 foreman/3.16/apidoc/v2/usergroups/create.html create mode 100644 foreman/3.16/apidoc/v2/usergroups/destroy.html create mode 100644 foreman/3.16/apidoc/v2/usergroups/index.html create mode 100644 foreman/3.16/apidoc/v2/usergroups/show.html create mode 100644 foreman/3.16/apidoc/v2/usergroups/update.html create mode 100644 foreman/3.16/apidoc/v2/users.html create mode 100644 foreman/3.16/apidoc/v2/users/create.html create mode 100644 foreman/3.16/apidoc/v2/users/destroy.html create mode 100644 foreman/3.16/apidoc/v2/users/extlogin.html create mode 100644 foreman/3.16/apidoc/v2/users/index.html create mode 100644 foreman/3.16/apidoc/v2/users/show.html create mode 100644 foreman/3.16/apidoc/v2/users/show_current.html create mode 100644 foreman/3.16/apidoc/v2/users/update.html create mode 100644 foreman/3.16/index.html diff --git a/foreman/3.16/apidoc/javascripts/apipie.js b/foreman/3.16/apidoc/javascripts/apipie.js new file mode 100644 index 00000000..9b49b0d7 --- /dev/null +++ b/foreman/3.16/apidoc/javascripts/apipie.js @@ -0,0 +1,6 @@ +$(document).ready(function() { + if (typeof prettyPrint == 'function') { + $('pre.ruby').addClass('prettyprint lang-rb'); + prettyPrint(); + } +}); \ No newline at end of file diff --git a/foreman/3.16/apidoc/javascripts/bundled/bootstrap-collapse.js b/foreman/3.16/apidoc/javascripts/bundled/bootstrap-collapse.js new file mode 100644 index 00000000..9a364468 --- /dev/null +++ b/foreman/3.16/apidoc/javascripts/bundled/bootstrap-collapse.js @@ -0,0 +1,138 @@ +/* ============================================================= + * bootstrap-collapse.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#collapse + * ============================================================= + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============================================================ */ + +!function( $ ){ + + "use strict" + + var Collapse = function ( element, options ) { + this.$element = $(element) + this.options = $.extend({}, $.fn.collapse.defaults, options) + + if (this.options["parent"]) { + this.$parent = $(this.options["parent"]) + } + + this.options.toggle && this.toggle() + } + + Collapse.prototype = { + + constructor: Collapse + + , dimension: function () { + var hasWidth = this.$element.hasClass('width') + return hasWidth ? 'width' : 'height' + } + + , show: function () { + var dimension = this.dimension() + , scroll = $.camelCase(['scroll', dimension].join('-')) + , actives = this.$parent && this.$parent.find('.in') + , hasData + + if (actives && actives.length) { + hasData = actives.data('collapse') + actives.collapse('hide') + hasData || actives.data('collapse', null) + } + + this.$element[dimension](0) + this.transition('addClass', 'show', 'shown') + this.$element[dimension](this.$element[0][scroll]) + + } + + , hide: function () { + var dimension = this.dimension() + this.reset(this.$element[dimension]()) + this.transition('removeClass', 'hide', 'hidden') + this.$element[dimension](0) + } + + , reset: function ( size ) { + var dimension = this.dimension() + + this.$element + .removeClass('collapse') + [dimension](size || 'auto') + [0].offsetWidth + + this.$element[size ? 'addClass' : 'removeClass']('collapse') + + return this + } + + , transition: function ( method, startEvent, completeEvent ) { + var that = this + , complete = function () { + if (startEvent == 'show') that.reset() + that.$element.trigger(completeEvent) + } + + this.$element + .trigger(startEvent) + [method]('in') + + $.support.transition && this.$element.hasClass('collapse') ? + this.$element.one($.support.transition.end, complete) : + complete() + } + + , toggle: function () { + this[this.$element.hasClass('in') ? 'hide' : 'show']() + } + + } + + /* COLLAPSIBLE PLUGIN DEFINITION + * ============================== */ + + $.fn.collapse = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('collapse') + , options = typeof option == 'object' && option + if (!data) $this.data('collapse', (data = new Collapse(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.collapse.defaults = { + toggle: true + } + + $.fn.collapse.Constructor = Collapse + + + /* COLLAPSIBLE DATA-API + * ==================== */ + + $(function () { + $('body').on('click.collapse.data-api', '[data-toggle=collapse]', function ( e ) { + var $this = $(this), href + , target = $this.attr('data-target') + || e.preventDefault() + || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '') //strip for ie7 + , option = $(target).data('collapse') ? 'toggle' : $this.data() + $(target).collapse(option) + }) + }) + +}( window.jQuery ); \ No newline at end of file diff --git a/foreman/3.16/apidoc/javascripts/bundled/bootstrap.js b/foreman/3.16/apidoc/javascripts/bundled/bootstrap.js new file mode 100644 index 00000000..ca868671 --- /dev/null +++ b/foreman/3.16/apidoc/javascripts/bundled/bootstrap.js @@ -0,0 +1,1726 @@ +/* =================================================== + * bootstrap-transition.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#transitions + * =================================================== + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================================================== */ + +!function( $ ) { + + $(function () { + + "use strict" + + /* CSS TRANSITION SUPPORT (https://gist.github.com/373874) + * ======================================================= */ + + $.support.transition = (function () { + var thisBody = document.body || document.documentElement + , thisStyle = thisBody.style + , support = thisStyle.transition !== undefined || thisStyle.WebkitTransition !== undefined || thisStyle.MozTransition !== undefined || thisStyle.MsTransition !== undefined || thisStyle.OTransition !== undefined + + return support && { + end: (function () { + var transitionEnd = "TransitionEnd" + if ( $.browser.webkit ) { + transitionEnd = "webkitTransitionEnd" + } else if ( $.browser.mozilla ) { + transitionEnd = "transitionend" + } else if ( $.browser.opera ) { + transitionEnd = "oTransitionEnd" + } + return transitionEnd + }()) + } + })() + + }) + +}( window.jQuery );/* ========================================================== + * bootstrap-alert.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#alerts + * ========================================================== + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================================================== */ + + +!function( $ ){ + + "use strict" + + /* ALERT CLASS DEFINITION + * ====================== */ + + var dismiss = '[data-dismiss="alert"]' + , Alert = function ( el ) { + $(el).on('click', dismiss, this.close) + } + + Alert.prototype = { + + constructor: Alert + + , close: function ( e ) { + var $this = $(this) + , selector = $this.attr('data-target') + , $parent + + if (!selector) { + selector = $this.attr('href') + selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7 + } + + $parent = $(selector) + $parent.trigger('close') + + e && e.preventDefault() + + $parent.length || ($parent = $this.hasClass('alert') ? $this : $this.parent()) + + $parent + .trigger('close') + .removeClass('in') + + function removeElement() { + $parent + .trigger('closed') + .remove() + } + + $.support.transition && $parent.hasClass('fade') ? + $parent.on($.support.transition.end, removeElement) : + removeElement() + } + + } + + + /* ALERT PLUGIN DEFINITION + * ======================= */ + + $.fn.alert = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('alert') + if (!data) $this.data('alert', (data = new Alert(this))) + if (typeof option == 'string') data[option].call($this) + }) + } + + $.fn.alert.Constructor = Alert + + + /* ALERT DATA-API + * ============== */ + + $(function () { + $('body').on('click.alert.data-api', dismiss, Alert.prototype.close) + }) + +}( window.jQuery );/* ============================================================ + * bootstrap-button.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#buttons + * ============================================================ + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============================================================ */ + +!function( $ ){ + + "use strict" + + /* BUTTON PUBLIC CLASS DEFINITION + * ============================== */ + + var Button = function ( element, options ) { + this.$element = $(element) + this.options = $.extend({}, $.fn.button.defaults, options) + } + + Button.prototype = { + + constructor: Button + + , setState: function ( state ) { + var d = 'disabled' + , $el = this.$element + , data = $el.data() + , val = $el.is('input') ? 'val' : 'html' + + state = state + 'Text' + data.resetText || $el.data('resetText', $el[val]()) + + $el[val](data[state] || this.options[state]) + + // push to event loop to allow forms to submit + setTimeout(function () { + state == 'loadingText' ? + $el.addClass(d).attr(d, d) : + $el.removeClass(d).removeAttr(d) + }, 0) + } + + , toggle: function () { + var $parent = this.$element.parent('[data-toggle="buttons-radio"]') + + $parent && $parent + .find('.active') + .removeClass('active') + + this.$element.toggleClass('active') + } + + } + + + /* BUTTON PLUGIN DEFINITION + * ======================== */ + + $.fn.button = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('button') + , options = typeof option == 'object' && option + if (!data) $this.data('button', (data = new Button(this, options))) + if (option == 'toggle') data.toggle() + else if (option) data.setState(option) + }) + } + + $.fn.button.defaults = { + loadingText: 'loading...' + } + + $.fn.button.Constructor = Button + + + /* BUTTON DATA-API + * =============== */ + + $(function () { + $('body').on('click.button.data-api', '[data-toggle^=button]', function ( e ) { + var $btn = $(e.target) + if (!$btn.hasClass('btn')) $btn = $btn.closest('.btn') + $btn.button('toggle') + }) + }) + +}( window.jQuery );/* ========================================================== + * bootstrap-carousel.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#carousel + * ========================================================== + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================================================== */ + + +!function( $ ){ + + "use strict" + + /* CAROUSEL CLASS DEFINITION + * ========================= */ + + var Carousel = function (element, options) { + this.$element = $(element) + this.options = $.extend({}, $.fn.carousel.defaults, options) + this.options.slide && this.slide(this.options.slide) + this.options.pause == 'hover' && this.$element + .on('mouseenter', $.proxy(this.pause, this)) + .on('mouseleave', $.proxy(this.cycle, this)) + } + + Carousel.prototype = { + + cycle: function () { + this.interval = setInterval($.proxy(this.next, this), this.options.interval) + return this + } + + , to: function (pos) { + var $active = this.$element.find('.active') + , children = $active.parent().children() + , activePos = children.index($active) + , that = this + + if (pos > (children.length - 1) || pos < 0) return + + if (this.sliding) { + return this.$element.one('slid', function () { + that.to(pos) + }) + } + + if (activePos == pos) { + return this.pause().cycle() + } + + return this.slide(pos > activePos ? 'next' : 'prev', $(children[pos])) + } + + , pause: function () { + clearInterval(this.interval) + this.interval = null + return this + } + + , next: function () { + if (this.sliding) return + return this.slide('next') + } + + , prev: function () { + if (this.sliding) return + return this.slide('prev') + } + + , slide: function (type, next) { + var $active = this.$element.find('.active') + , $next = next || $active[type]() + , isCycling = this.interval + , direction = type == 'next' ? 'left' : 'right' + , fallback = type == 'next' ? 'first' : 'last' + , that = this + + this.sliding = true + + isCycling && this.pause() + + $next = $next.length ? $next : this.$element.find('.item')[fallback]() + + if ($next.hasClass('active')) return + + if (!$.support.transition && this.$element.hasClass('slide')) { + this.$element.trigger('slide') + $active.removeClass('active') + $next.addClass('active') + this.sliding = false + this.$element.trigger('slid') + } else { + $next.addClass(type) + $next[0].offsetWidth // force reflow + $active.addClass(direction) + $next.addClass(direction) + this.$element.trigger('slide') + this.$element.one($.support.transition.end, function () { + $next.removeClass([type, direction].join(' ')).addClass('active') + $active.removeClass(['active', direction].join(' ')) + that.sliding = false + setTimeout(function () { that.$element.trigger('slid') }, 0) + }) + } + + isCycling && this.cycle() + + return this + } + + } + + + /* CAROUSEL PLUGIN DEFINITION + * ========================== */ + + $.fn.carousel = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('carousel') + , options = typeof option == 'object' && option + if (!data) $this.data('carousel', (data = new Carousel(this, options))) + if (typeof option == 'number') data.to(option) + else if (typeof option == 'string' || (option = options.slide)) data[option]() + else data.cycle() + }) + } + + $.fn.carousel.defaults = { + interval: 5000 + , pause: 'hover' + } + + $.fn.carousel.Constructor = Carousel + + + /* CAROUSEL DATA-API + * ================= */ + + $(function () { + $('body').on('click.carousel.data-api', '[data-slide]', function ( e ) { + var $this = $(this), href + , $target = $($this.attr('data-target') || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) //strip for ie7 + , options = !$target.data('modal') && $.extend({}, $target.data(), $this.data()) + $target.carousel(options) + e.preventDefault() + }) + }) + +}( window.jQuery );/* ============================================================= + * bootstrap-collapse.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#collapse + * ============================================================= + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============================================================ */ + +!function( $ ){ + + "use strict" + + var Collapse = function ( element, options ) { + this.$element = $(element) + this.options = $.extend({}, $.fn.collapse.defaults, options) + + if (this.options["parent"]) { + this.$parent = $(this.options["parent"]) + } + + this.options.toggle && this.toggle() + } + + Collapse.prototype = { + + constructor: Collapse + + , dimension: function () { + var hasWidth = this.$element.hasClass('width') + return hasWidth ? 'width' : 'height' + } + + , show: function () { + var dimension = this.dimension() + , scroll = $.camelCase(['scroll', dimension].join('-')) + , actives = this.$parent && this.$parent.find('.in') + , hasData + + if (actives && actives.length) { + hasData = actives.data('collapse') + actives.collapse('hide') + hasData || actives.data('collapse', null) + } + + this.$element[dimension](0) + this.transition('addClass', 'show', 'shown') + this.$element[dimension](this.$element[0][scroll]) + + } + + , hide: function () { + var dimension = this.dimension() + this.reset(this.$element[dimension]()) + this.transition('removeClass', 'hide', 'hidden') + this.$element[dimension](0) + } + + , reset: function ( size ) { + var dimension = this.dimension() + + this.$element + .removeClass('collapse') + [dimension](size || 'auto') + [0].offsetWidth + + this.$element[size ? 'addClass' : 'removeClass']('collapse') + + return this + } + + , transition: function ( method, startEvent, completeEvent ) { + var that = this + , complete = function () { + if (startEvent == 'show') that.reset() + that.$element.trigger(completeEvent) + } + + this.$element + .trigger(startEvent) + [method]('in') + + $.support.transition && this.$element.hasClass('collapse') ? + this.$element.one($.support.transition.end, complete) : + complete() + } + + , toggle: function () { + this[this.$element.hasClass('in') ? 'hide' : 'show']() + } + + } + + /* COLLAPSIBLE PLUGIN DEFINITION + * ============================== */ + + $.fn.collapse = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('collapse') + , options = typeof option == 'object' && option + if (!data) $this.data('collapse', (data = new Collapse(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.collapse.defaults = { + toggle: true + } + + $.fn.collapse.Constructor = Collapse + + + /* COLLAPSIBLE DATA-API + * ==================== */ + + $(function () { + $('body').on('click.collapse.data-api', '[data-toggle=collapse]', function ( e ) { + var $this = $(this), href + , target = $this.attr('data-target') + || e.preventDefault() + || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '') //strip for ie7 + , option = $(target).data('collapse') ? 'toggle' : $this.data() + $(target).collapse(option) + }) + }) + +}( window.jQuery );/* ============================================================ + * bootstrap-dropdown.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#dropdowns + * ============================================================ + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============================================================ */ + + +!function( $ ){ + + "use strict" + + /* DROPDOWN CLASS DEFINITION + * ========================= */ + + var toggle = '[data-toggle="dropdown"]' + , Dropdown = function ( element ) { + var $el = $(element).on('click.dropdown.data-api', this.toggle) + $('html').on('click.dropdown.data-api', function () { + $el.parent().removeClass('open') + }) + } + + Dropdown.prototype = { + + constructor: Dropdown + + , toggle: function ( e ) { + var $this = $(this) + , selector = $this.attr('data-target') + , $parent + , isActive + + if (!selector) { + selector = $this.attr('href') + selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7 + } + + $parent = $(selector) + $parent.length || ($parent = $this.parent()) + + isActive = $parent.hasClass('open') + + clearMenus() + !isActive && $parent.toggleClass('open') + + return false + } + + } + + function clearMenus() { + $(toggle).parent().removeClass('open') + } + + + /* DROPDOWN PLUGIN DEFINITION + * ========================== */ + + $.fn.dropdown = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('dropdown') + if (!data) $this.data('dropdown', (data = new Dropdown(this))) + if (typeof option == 'string') data[option].call($this) + }) + } + + $.fn.dropdown.Constructor = Dropdown + + + /* APPLY TO STANDARD DROPDOWN ELEMENTS + * =================================== */ + + $(function () { + $('html').on('click.dropdown.data-api', clearMenus) + $('body').on('click.dropdown.data-api', toggle, Dropdown.prototype.toggle) + }) + +}( window.jQuery );/* ========================================================= + * bootstrap-modal.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#modals + * ========================================================= + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================================================= */ + + +!function( $ ){ + + "use strict" + + /* MODAL CLASS DEFINITION + * ====================== */ + + var Modal = function ( content, options ) { + this.options = options + this.$element = $(content) + .delegate('[data-dismiss="modal"]', 'click.dismiss.modal', $.proxy(this.hide, this)) + } + + Modal.prototype = { + + constructor: Modal + + , toggle: function () { + return this[!this.isShown ? 'show' : 'hide']() + } + + , show: function () { + var that = this + + if (this.isShown) return + + $('body').addClass('modal-open') + + this.isShown = true + this.$element.trigger('show') + + escape.call(this) + backdrop.call(this, function () { + var transition = $.support.transition && that.$element.hasClass('fade') + + !that.$element.parent().length && that.$element.appendTo(document.body) //don't move modals dom position + + that.$element + .show() + + if (transition) { + that.$element[0].offsetWidth // force reflow + } + + that.$element.addClass('in') + + transition ? + that.$element.one($.support.transition.end, function () { that.$element.trigger('shown') }) : + that.$element.trigger('shown') + + }) + } + + , hide: function ( e ) { + e && e.preventDefault() + + if (!this.isShown) return + + var that = this + this.isShown = false + + $('body').removeClass('modal-open') + + escape.call(this) + + this.$element + .trigger('hide') + .removeClass('in') + + $.support.transition && this.$element.hasClass('fade') ? + hideWithTransition.call(this) : + hideModal.call(this) + } + + } + + + /* MODAL PRIVATE METHODS + * ===================== */ + + function hideWithTransition() { + var that = this + , timeout = setTimeout(function () { + that.$element.off($.support.transition.end) + hideModal.call(that) + }, 500) + + this.$element.one($.support.transition.end, function () { + clearTimeout(timeout) + hideModal.call(that) + }) + } + + function hideModal( that ) { + this.$element + .hide() + .trigger('hidden') + + backdrop.call(this) + } + + function backdrop( callback ) { + var that = this + , animate = this.$element.hasClass('fade') ? 'fade' : '' + + if (this.isShown && this.options.backdrop) { + var doAnimate = $.support.transition && animate + + this.$backdrop = $('
') + .appendTo(document.body) + + if (this.options.backdrop != 'static') { + this.$backdrop.click($.proxy(this.hide, this)) + } + + if (doAnimate) this.$backdrop[0].offsetWidth // force reflow + + this.$backdrop.addClass('in') + + doAnimate ? + this.$backdrop.one($.support.transition.end, callback) : + callback() + + } else if (!this.isShown && this.$backdrop) { + this.$backdrop.removeClass('in') + + $.support.transition && this.$element.hasClass('fade')? + this.$backdrop.one($.support.transition.end, $.proxy(removeBackdrop, this)) : + removeBackdrop.call(this) + + } else if (callback) { + callback() + } + } + + function removeBackdrop() { + this.$backdrop.remove() + this.$backdrop = null + } + + function escape() { + var that = this + if (this.isShown && this.options.keyboard) { + $(document).on('keyup.dismiss.modal', function ( e ) { + e.which == 27 && that.hide() + }) + } else if (!this.isShown) { + $(document).off('keyup.dismiss.modal') + } + } + + + /* MODAL PLUGIN DEFINITION + * ======================= */ + + $.fn.modal = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('modal') + , options = $.extend({}, $.fn.modal.defaults, $this.data(), typeof option == 'object' && option) + if (!data) $this.data('modal', (data = new Modal(this, options))) + if (typeof option == 'string') data[option]() + else if (options.show) data.show() + }) + } + + $.fn.modal.defaults = { + backdrop: true + , keyboard: true + , show: true + } + + $.fn.modal.Constructor = Modal + + + /* MODAL DATA-API + * ============== */ + + $(function () { + $('body').on('click.modal.data-api', '[data-toggle="modal"]', function ( e ) { + var $this = $(this), href + , $target = $($this.attr('data-target') || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) //strip for ie7 + , option = $target.data('modal') ? 'toggle' : $.extend({}, $target.data(), $this.data()) + + e.preventDefault() + $target.modal(option) + }) + }) + +}( window.jQuery );/* =========================================================== + * bootstrap-tooltip.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#tooltips + * Inspired by the original jQuery.tipsy by Jason Frame + * =========================================================== + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================================================== */ + +!function( $ ) { + + "use strict" + + /* TOOLTIP PUBLIC CLASS DEFINITION + * =============================== */ + + var Tooltip = function ( element, options ) { + this.init('tooltip', element, options) + } + + Tooltip.prototype = { + + constructor: Tooltip + + , init: function ( type, element, options ) { + var eventIn + , eventOut + + this.type = type + this.$element = $(element) + this.options = this.getOptions(options) + this.enabled = true + + if (this.options.trigger != 'manual') { + eventIn = this.options.trigger == 'hover' ? 'mouseenter' : 'focus' + eventOut = this.options.trigger == 'hover' ? 'mouseleave' : 'blur' + this.$element.on(eventIn, this.options.selector, $.proxy(this.enter, this)) + this.$element.on(eventOut, this.options.selector, $.proxy(this.leave, this)) + } + + this.options.selector ? + (this._options = $.extend({}, this.options, { trigger: 'manual', selector: '' })) : + this.fixTitle() + } + + , getOptions: function ( options ) { + options = $.extend({}, $.fn[this.type].defaults, options, this.$element.data()) + + if (options.delay && typeof options.delay == 'number') { + options.delay = { + show: options.delay + , hide: options.delay + } + } + + return options + } + + , enter: function ( e ) { + var self = $(e.currentTarget)[this.type](this._options).data(this.type) + + if (!self.options.delay || !self.options.delay.show) { + self.show() + } else { + self.hoverState = 'in' + setTimeout(function() { + if (self.hoverState == 'in') { + self.show() + } + }, self.options.delay.show) + } + } + + , leave: function ( e ) { + var self = $(e.currentTarget)[this.type](this._options).data(this.type) + + if (!self.options.delay || !self.options.delay.hide) { + self.hide() + } else { + self.hoverState = 'out' + setTimeout(function() { + if (self.hoverState == 'out') { + self.hide() + } + }, self.options.delay.hide) + } + } + + , show: function () { + var $tip + , inside + , pos + , actualWidth + , actualHeight + , placement + , tp + + if (this.hasContent() && this.enabled) { + $tip = this.tip() + this.setContent() + + if (this.options.animation) { + $tip.addClass('fade') + } + + placement = typeof this.options.placement == 'function' ? + this.options.placement.call(this, $tip[0], this.$element[0]) : + this.options.placement + + inside = /in/.test(placement) + + $tip + .remove() + .css({ top: 0, left: 0, display: 'block' }) + .appendTo(inside ? this.$element : document.body) + + pos = this.getPosition(inside) + + actualWidth = $tip[0].offsetWidth + actualHeight = $tip[0].offsetHeight + + switch (inside ? placement.split(' ')[1] : placement) { + case 'bottom': + tp = {top: pos.top + pos.height, left: pos.left + pos.width / 2 - actualWidth / 2} + break + case 'top': + tp = {top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2} + break + case 'left': + tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth} + break + case 'right': + tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width} + break + } + + $tip + .css(tp) + .addClass(placement) + .addClass('in') + } + } + + , setContent: function () { + var $tip = this.tip() + $tip.find('.tooltip-inner').html(this.getTitle()) + $tip.removeClass('fade in top bottom left right') + } + + , hide: function () { + var that = this + , $tip = this.tip() + + $tip.removeClass('in') + + function removeWithAnimation() { + var timeout = setTimeout(function () { + $tip.off($.support.transition.end).remove() + }, 500) + + $tip.one($.support.transition.end, function () { + clearTimeout(timeout) + $tip.remove() + }) + } + + $.support.transition && this.$tip.hasClass('fade') ? + removeWithAnimation() : + $tip.remove() + } + + , fixTitle: function () { + var $e = this.$element + if ($e.attr('title') || typeof($e.attr('data-original-title')) != 'string') { + $e.attr('data-original-title', $e.attr('title') || '').removeAttr('title') + } + } + + , hasContent: function () { + return this.getTitle() + } + + , getPosition: function (inside) { + return $.extend({}, (inside ? {top: 0, left: 0} : this.$element.offset()), { + width: this.$element[0].offsetWidth + , height: this.$element[0].offsetHeight + }) + } + + , getTitle: function () { + var title + , $e = this.$element + , o = this.options + + title = $e.attr('data-original-title') + || (typeof o.title == 'function' ? o.title.call($e[0]) : o.title) + + title = (title || '').toString().replace(/(^\s*|\s*$)/, "") + + return title + } + + , tip: function () { + return this.$tip = this.$tip || $(this.options.template) + } + + , validate: function () { + if (!this.$element[0].parentNode) { + this.hide() + this.$element = null + this.options = null + } + } + + , enable: function () { + this.enabled = true + } + + , disable: function () { + this.enabled = false + } + + , toggleEnabled: function () { + this.enabled = !this.enabled + } + + , toggle: function () { + this[this.tip().hasClass('in') ? 'hide' : 'show']() + } + + } + + + /* TOOLTIP PLUGIN DEFINITION + * ========================= */ + + $.fn.tooltip = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('tooltip') + , options = typeof option == 'object' && option + if (!data) $this.data('tooltip', (data = new Tooltip(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.tooltip.Constructor = Tooltip + + $.fn.tooltip.defaults = { + animation: true + , delay: 0 + , selector: false + , placement: 'top' + , trigger: 'hover' + , title: '' + , template: '
' + } + +}( window.jQuery );/* =========================================================== + * bootstrap-popover.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#popovers + * =========================================================== + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * =========================================================== */ + + +!function( $ ) { + + "use strict" + + var Popover = function ( element, options ) { + this.init('popover', element, options) + } + + /* NOTE: POPOVER EXTENDS BOOTSTRAP-TOOLTIP.js + ========================================== */ + + Popover.prototype = $.extend({}, $.fn.tooltip.Constructor.prototype, { + + constructor: Popover + + , setContent: function () { + var $tip = this.tip() + , title = this.getTitle() + , content = this.getContent() + + $tip.find('.popover-title')[ $.type(title) == 'object' ? 'append' : 'html' ](title) + $tip.find('.popover-content > *')[ $.type(content) == 'object' ? 'append' : 'html' ](content) + + $tip.removeClass('fade top bottom left right in') + } + + , hasContent: function () { + return this.getTitle() || this.getContent() + } + + , getContent: function () { + var content + , $e = this.$element + , o = this.options + + content = $e.attr('data-content') + || (typeof o.content == 'function' ? o.content.call($e[0]) : o.content) + + content = content.toString().replace(/(^\s*|\s*$)/, "") + + return content + } + + , tip: function() { + if (!this.$tip) { + this.$tip = $(this.options.template) + } + return this.$tip + } + + }) + + + /* POPOVER PLUGIN DEFINITION + * ======================= */ + + $.fn.popover = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('popover') + , options = typeof option == 'object' && option + if (!data) $this.data('popover', (data = new Popover(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.popover.Constructor = Popover + + $.fn.popover.defaults = $.extend({} , $.fn.tooltip.defaults, { + placement: 'right' + , content: '' + , template: '

' + }) + +}( window.jQuery );/* ============================================================= + * bootstrap-scrollspy.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#scrollspy + * ============================================================= + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============================================================== */ + +!function ( $ ) { + + "use strict" + + /* SCROLLSPY CLASS DEFINITION + * ========================== */ + + function ScrollSpy( element, options) { + var process = $.proxy(this.process, this) + , $element = $(element).is('body') ? $(window) : $(element) + , href + this.options = $.extend({}, $.fn.scrollspy.defaults, options) + this.$scrollElement = $element.on('scroll.scroll.data-api', process) + this.selector = (this.options.target + || ((href = $(element).attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) //strip for ie7 + || '') + ' .nav li > a' + this.$body = $('body').on('click.scroll.data-api', this.selector, process) + this.refresh() + this.process() + } + + ScrollSpy.prototype = { + + constructor: ScrollSpy + + , refresh: function () { + this.targets = this.$body + .find(this.selector) + .map(function () { + var href = $(this).attr('href') + return /^#\w/.test(href) && $(href).length ? href : null + }) + + this.offsets = $.map(this.targets, function (id) { + return $(id).position().top + }) + } + + , process: function () { + var scrollTop = this.$scrollElement.scrollTop() + this.options.offset + , offsets = this.offsets + , targets = this.targets + , activeTarget = this.activeTarget + , i + + for (i = offsets.length; i--;) { + activeTarget != targets[i] + && scrollTop >= offsets[i] + && (!offsets[i + 1] || scrollTop <= offsets[i + 1]) + && this.activate( targets[i] ) + } + } + + , activate: function (target) { + var active + + this.activeTarget = target + + this.$body + .find(this.selector).parent('.active') + .removeClass('active') + + active = this.$body + .find(this.selector + '[href="' + target + '"]') + .parent('li') + .addClass('active') + + if ( active.parent('.dropdown-menu') ) { + active.closest('li.dropdown').addClass('active') + } + } + + } + + + /* SCROLLSPY PLUGIN DEFINITION + * =========================== */ + + $.fn.scrollspy = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('scrollspy') + , options = typeof option == 'object' && option + if (!data) $this.data('scrollspy', (data = new ScrollSpy(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.scrollspy.Constructor = ScrollSpy + + $.fn.scrollspy.defaults = { + offset: 10 + } + + + /* SCROLLSPY DATA-API + * ================== */ + + $(function () { + $('[data-spy="scroll"]').each(function () { + var $spy = $(this) + $spy.scrollspy($spy.data()) + }) + }) + +}( window.jQuery );/* ======================================================== + * bootstrap-tab.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#tabs + * ======================================================== + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ======================================================== */ + + +!function( $ ){ + + "use strict" + + /* TAB CLASS DEFINITION + * ==================== */ + + var Tab = function ( element ) { + this.element = $(element) + } + + Tab.prototype = { + + constructor: Tab + + , show: function () { + var $this = this.element + , $ul = $this.closest('ul:not(.dropdown-menu)') + , selector = $this.attr('data-target') + , previous + , $target + + if (!selector) { + selector = $this.attr('href') + selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7 + } + + if ( $this.parent('li').hasClass('active') ) return + + previous = $ul.find('.active a').last()[0] + + $this.trigger({ + type: 'show' + , relatedTarget: previous + }) + + $target = $(selector) + + this.activate($this.parent('li'), $ul) + this.activate($target, $target.parent(), function () { + $this.trigger({ + type: 'shown' + , relatedTarget: previous + }) + }) + } + + , activate: function ( element, container, callback) { + var $active = container.find('> .active') + , transition = callback + && $.support.transition + && $active.hasClass('fade') + + function next() { + $active + .removeClass('active') + .find('> .dropdown-menu > .active') + .removeClass('active') + + element.addClass('active') + + if (transition) { + element[0].offsetWidth // reflow for transition + element.addClass('in') + } else { + element.removeClass('fade') + } + + if ( element.parent('.dropdown-menu') ) { + element.closest('li.dropdown').addClass('active') + } + + callback && callback() + } + + transition ? + $active.one($.support.transition.end, next) : + next() + + $active.removeClass('in') + } + } + + + /* TAB PLUGIN DEFINITION + * ===================== */ + + $.fn.tab = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('tab') + if (!data) $this.data('tab', (data = new Tab(this))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.tab.Constructor = Tab + + + /* TAB DATA-API + * ============ */ + + $(function () { + $('body').on('click.tab.data-api', '[data-toggle="tab"], [data-toggle="pill"]', function (e) { + e.preventDefault() + $(this).tab('show') + }) + }) + +}( window.jQuery );/* ============================================================= + * bootstrap-typeahead.js v2.0.2 + * http://twitter.github.com/bootstrap/javascript.html#typeahead + * ============================================================= + * Copyright 2012 Twitter, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============================================================ */ + +!function( $ ){ + + "use strict" + + var Typeahead = function ( element, options ) { + this.$element = $(element) + this.options = $.extend({}, $.fn.typeahead.defaults, options) + this.matcher = this.options.matcher || this.matcher + this.sorter = this.options.sorter || this.sorter + this.highlighter = this.options.highlighter || this.highlighter + this.$menu = $(this.options.menu).appendTo('body') + this.source = this.options.source + this.shown = false + this.listen() + } + + Typeahead.prototype = { + + constructor: Typeahead + + , select: function () { + var val = this.$menu.find('.active').attr('data-value') + this.$element.val(val) + this.$element.change(); + return this.hide() + } + + , show: function () { + var pos = $.extend({}, this.$element.offset(), { + height: this.$element[0].offsetHeight + }) + + this.$menu.css({ + top: pos.top + pos.height + , left: pos.left + }) + + this.$menu.show() + this.shown = true + return this + } + + , hide: function () { + this.$menu.hide() + this.shown = false + return this + } + + , lookup: function (event) { + var that = this + , items + , q + + this.query = this.$element.val() + + if (!this.query) { + return this.shown ? this.hide() : this + } + + items = $.grep(this.source, function (item) { + if (that.matcher(item)) return item + }) + + items = this.sorter(items) + + if (!items.length) { + return this.shown ? this.hide() : this + } + + return this.render(items.slice(0, this.options.items)).show() + } + + , matcher: function (item) { + return ~item.toLowerCase().indexOf(this.query.toLowerCase()) + } + + , sorter: function (items) { + var beginswith = [] + , caseSensitive = [] + , caseInsensitive = [] + , item + + while (item = items.shift()) { + if (!item.toLowerCase().indexOf(this.query.toLowerCase())) beginswith.push(item) + else if (~item.indexOf(this.query)) caseSensitive.push(item) + else caseInsensitive.push(item) + } + + return beginswith.concat(caseSensitive, caseInsensitive) + } + + , highlighter: function (item) { + return item.replace(new RegExp('(' + this.query + ')', 'ig'), function ($1, match) { + return '' + match + '' + }) + } + + , render: function (items) { + var that = this + + items = $(items).map(function (i, item) { + i = $(that.options.item).attr('data-value', item) + i.find('a').html(that.highlighter(item)) + return i[0] + }) + + items.first().addClass('active') + this.$menu.html(items) + return this + } + + , next: function (event) { + var active = this.$menu.find('.active').removeClass('active') + , next = active.next() + + if (!next.length) { + next = $(this.$menu.find('li')[0]) + } + + next.addClass('active') + } + + , prev: function (event) { + var active = this.$menu.find('.active').removeClass('active') + , prev = active.prev() + + if (!prev.length) { + prev = this.$menu.find('li').last() + } + + prev.addClass('active') + } + + , listen: function () { + this.$element + .on('blur', $.proxy(this.blur, this)) + .on('keypress', $.proxy(this.keypress, this)) + .on('keyup', $.proxy(this.keyup, this)) + + if ($.browser.webkit || $.browser.msie) { + this.$element.on('keydown', $.proxy(this.keypress, this)) + } + + this.$menu + .on('click', $.proxy(this.click, this)) + .on('mouseenter', 'li', $.proxy(this.mouseenter, this)) + } + + , keyup: function (e) { + switch(e.keyCode) { + case 40: // down arrow + case 38: // up arrow + break + + case 9: // tab + case 13: // enter + if (!this.shown) return + this.select() + break + + case 27: // escape + if (!this.shown) return + this.hide() + break + + default: + this.lookup() + } + + e.stopPropagation() + e.preventDefault() + } + + , keypress: function (e) { + if (!this.shown) return + + switch(e.keyCode) { + case 9: // tab + case 13: // enter + case 27: // escape + e.preventDefault() + break + + case 38: // up arrow + e.preventDefault() + this.prev() + break + + case 40: // down arrow + e.preventDefault() + this.next() + break + } + + e.stopPropagation() + } + + , blur: function (e) { + var that = this + setTimeout(function () { that.hide() }, 150) + } + + , click: function (e) { + e.stopPropagation() + e.preventDefault() + this.select() + } + + , mouseenter: function (e) { + this.$menu.find('.active').removeClass('active') + $(e.currentTarget).addClass('active') + } + + } + + + /* TYPEAHEAD PLUGIN DEFINITION + * =========================== */ + + $.fn.typeahead = function ( option ) { + return this.each(function () { + var $this = $(this) + , data = $this.data('typeahead') + , options = typeof option == 'object' && option + if (!data) $this.data('typeahead', (data = new Typeahead(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + $.fn.typeahead.defaults = { + source: [] + , items: 8 + , menu: '' + , item: '
    • ' + } + + $.fn.typeahead.Constructor = Typeahead + + + /* TYPEAHEAD DATA-API + * ================== */ + + $(function () { + $('body').on('focus.typeahead.data-api', '[data-provide="typeahead"]', function (e) { + var $this = $(this) + if ($this.data('typeahead')) return + e.preventDefault() + $this.typeahead($this.data()) + }) + }) + +}( window.jQuery ); \ No newline at end of file diff --git a/foreman/3.16/apidoc/javascripts/bundled/jquery.js b/foreman/3.16/apidoc/javascripts/bundled/jquery.js new file mode 100644 index 00000000..3774ff98 --- /dev/null +++ b/foreman/3.16/apidoc/javascripts/bundled/jquery.js @@ -0,0 +1,9404 @@ +/*! + * jQuery JavaScript Library v1.7.2 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Wed Mar 21 12:46:34 2012 -0700 + */ +(function( window, undefined ) { + +// Use the correct document accordingly with window argument (sandbox) +var document = window.document, + navigator = window.navigator, + location = window.location; +var jQuery = (function() { + +// Define a local copy of jQuery +var jQuery = function( selector, context ) { + // The jQuery object is actually just the init constructor 'enhanced' + return new jQuery.fn.init( selector, context, rootjQuery ); + }, + + // Map over jQuery in case of overwrite + _jQuery = window.jQuery, + + // Map over the $ in case of overwrite + _$ = window.$, + + // A central reference to the root jQuery(document) + rootjQuery, + + // A simple way to check for HTML strings or ID strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + quickExpr = /^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/, + + // Check if a string has a non-whitespace character in it + rnotwhite = /\S/, + + // Used for trimming whitespace + trimLeft = /^\s+/, + trimRight = /\s+$/, + + // Match a standalone tag + rsingleTag = /^<(\w+)\s*\/?>(?:<\/\1>)?$/, + + // JSON RegExp + rvalidchars = /^[\],:{}\s]*$/, + rvalidescape = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, + rvalidtokens = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, + rvalidbraces = /(?:^|:|,)(?:\s*\[)+/g, + + // Useragent RegExp + rwebkit = /(webkit)[ \/]([\w.]+)/, + ropera = /(opera)(?:.*version)?[ \/]([\w.]+)/, + rmsie = /(msie) ([\w.]+)/, + rmozilla = /(mozilla)(?:.*? rv:([\w.]+))?/, + + // Matches dashed string for camelizing + rdashAlpha = /-([a-z]|[0-9])/ig, + rmsPrefix = /^-ms-/, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return ( letter + "" ).toUpperCase(); + }, + + // Keep a UserAgent string for use with jQuery.browser + userAgent = navigator.userAgent, + + // For matching the engine and version of the browser + browserMatch, + + // The deferred used on DOM ready + readyList, + + // The ready event handler + DOMContentLoaded, + + // Save a reference to some core methods + toString = Object.prototype.toString, + hasOwn = Object.prototype.hasOwnProperty, + push = Array.prototype.push, + slice = Array.prototype.slice, + trim = String.prototype.trim, + indexOf = Array.prototype.indexOf, + + // [[Class]] -> type pairs + class2type = {}; + +jQuery.fn = jQuery.prototype = { + constructor: jQuery, + init: function( selector, context, rootjQuery ) { + var match, elem, ret, doc; + + // Handle $(""), $(null), or $(undefined) + if ( !selector ) { + return this; + } + + // Handle $(DOMElement) + if ( selector.nodeType ) { + this.context = this[0] = selector; + this.length = 1; + return this; + } + + // The body element only exists once, optimize finding it + if ( selector === "body" && !context && document.body ) { + this.context = document; + this[0] = document.body; + this.selector = selector; + this.length = 1; + return this; + } + + // Handle HTML strings + if ( typeof selector === "string" ) { + // Are we dealing with HTML string or an ID? + if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = quickExpr.exec( selector ); + } + + // Verify a match, and that no context was specified for #id + if ( match && (match[1] || !context) ) { + + // HANDLE: $(html) -> $(array) + if ( match[1] ) { + context = context instanceof jQuery ? context[0] : context; + doc = ( context ? context.ownerDocument || context : document ); + + // If a single string is passed in and it's a single tag + // just do a createElement and skip the rest + ret = rsingleTag.exec( selector ); + + if ( ret ) { + if ( jQuery.isPlainObject( context ) ) { + selector = [ document.createElement( ret[1] ) ]; + jQuery.fn.attr.call( selector, context, true ); + + } else { + selector = [ doc.createElement( ret[1] ) ]; + } + + } else { + ret = jQuery.buildFragment( [ match[1] ], [ doc ] ); + selector = ( ret.cacheable ? jQuery.clone(ret.fragment) : ret.fragment ).childNodes; + } + + return jQuery.merge( this, selector ); + + // HANDLE: $("#id") + } else { + elem = document.getElementById( match[2] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id !== match[2] ) { + return rootjQuery.find( selector ); + } + + // Otherwise, we inject the element directly into the jQuery object + this.length = 1; + this[0] = elem; + } + + this.context = document; + this.selector = selector; + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || rootjQuery ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return rootjQuery.ready( selector ); + } + + if ( selector.selector !== undefined ) { + this.selector = selector.selector; + this.context = selector.context; + } + + return jQuery.makeArray( selector, this ); + }, + + // Start with an empty selector + selector: "", + + // The current version of jQuery being used + jquery: "1.7.2", + + // The default length of a jQuery object is 0 + length: 0, + + // The number of elements contained in the matched element set + size: function() { + return this.length; + }, + + toArray: function() { + return slice.call( this, 0 ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + return num == null ? + + // Return a 'clean' array + this.toArray() : + + // Return just the object + ( num < 0 ? this[ this.length + num ] : this[ num ] ); + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems, name, selector ) { + // Build a new jQuery matched element set + var ret = this.constructor(); + + if ( jQuery.isArray( elems ) ) { + push.apply( ret, elems ); + + } else { + jQuery.merge( ret, elems ); + } + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + ret.context = this.context; + + if ( name === "find" ) { + ret.selector = this.selector + ( this.selector ? " " : "" ) + selector; + } else if ( name ) { + ret.selector = this.selector + "." + name + "(" + selector + ")"; + } + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + // (You can seed the arguments with an array of args, but this is + // only used internally.) + each: function( callback, args ) { + return jQuery.each( this, callback, args ); + }, + + ready: function( fn ) { + // Attach the listeners + jQuery.bindReady(); + + // Add the callback + readyList.add( fn ); + + return this; + }, + + eq: function( i ) { + i = +i; + return i === -1 ? + this.slice( i ) : + this.slice( i, i + 1 ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ), + "slice", slice.call(arguments).join(",") ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map(this, function( elem, i ) { + return callback.call( elem, i, elem ); + })); + }, + + end: function() { + return this.prevObject || this.constructor(null); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: [].sort, + splice: [].splice +}; + +// Give the init function the jQuery prototype for later instantiation +jQuery.fn.init.prototype = jQuery.fn; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[0] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + target = arguments[1] || {}; + // skip the boolean and the target + i = 2; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction(target) ) { + target = {}; + } + + // extend jQuery itself if only one argument is passed + if ( length === i ) { + target = this; + --i; + } + + for ( ; i < length; i++ ) { + // Only deal with non-null/undefined values + if ( (options = arguments[ i ]) != null ) { + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { + if ( copyIsArray ) { + copyIsArray = false; + clone = src && jQuery.isArray(src) ? src : []; + + } else { + clone = src && jQuery.isPlainObject(src) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend({ + noConflict: function( deep ) { + if ( window.$ === jQuery ) { + window.$ = _$; + } + + if ( deep && window.jQuery === jQuery ) { + window.jQuery = _jQuery; + } + + return jQuery; + }, + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Hold (or release) the ready event + holdReady: function( hold ) { + if ( hold ) { + jQuery.readyWait++; + } else { + jQuery.ready( true ); + } + }, + + // Handle when the DOM is ready + ready: function( wait ) { + // Either a released hold or an DOMready/load event and not yet ready + if ( (wait === true && !--jQuery.readyWait) || (wait !== true && !jQuery.isReady) ) { + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( !document.body ) { + return setTimeout( jQuery.ready, 1 ); + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.fireWith( document, [ jQuery ] ); + + // Trigger any bound ready events + if ( jQuery.fn.trigger ) { + jQuery( document ).trigger( "ready" ).off( "ready" ); + } + } + }, + + bindReady: function() { + if ( readyList ) { + return; + } + + readyList = jQuery.Callbacks( "once memory" ); + + // Catch cases where $(document).ready() is called after the + // browser event has already occurred. + if ( document.readyState === "complete" ) { + // Handle it asynchronously to allow scripts the opportunity to delay ready + return setTimeout( jQuery.ready, 1 ); + } + + // Mozilla, Opera and webkit nightlies currently support this event + if ( document.addEventListener ) { + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", DOMContentLoaded, false ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", jQuery.ready, false ); + + // If IE event model is used + } else if ( document.attachEvent ) { + // ensure firing before onload, + // maybe late but safe also for iframes + document.attachEvent( "onreadystatechange", DOMContentLoaded ); + + // A fallback to window.onload, that will always work + window.attachEvent( "onload", jQuery.ready ); + + // If IE and not a frame + // continually check to see if the document is ready + var toplevel = false; + + try { + toplevel = window.frameElement == null; + } catch(e) {} + + if ( document.documentElement.doScroll && toplevel ) { + doScrollCheck(); + } + } + }, + + // See test/unit/core.js for details concerning isFunction. + // Since version 1.3, DOM methods and functions like alert + // aren't supported. They return false on IE (#2968). + isFunction: function( obj ) { + return jQuery.type(obj) === "function"; + }, + + isArray: Array.isArray || function( obj ) { + return jQuery.type(obj) === "array"; + }, + + isWindow: function( obj ) { + return obj != null && obj == obj.window; + }, + + isNumeric: function( obj ) { + return !isNaN( parseFloat(obj) ) && isFinite( obj ); + }, + + type: function( obj ) { + return obj == null ? + String( obj ) : + class2type[ toString.call(obj) ] || "object"; + }, + + isPlainObject: function( obj ) { + // Must be an Object. + // Because of IE, we also have to check the presence of the constructor property. + // Make sure that DOM nodes and window objects don't pass through, as well + if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { + return false; + } + + try { + // Not own constructor property must be Object + if ( obj.constructor && + !hasOwn.call(obj, "constructor") && + !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { + return false; + } + } catch ( e ) { + // IE8,9 Will throw exceptions on certain host objects #9897 + return false; + } + + // Own properties are enumerated firstly, so to speed up, + // if last one is own, then all properties are own. + + var key; + for ( key in obj ) {} + + return key === undefined || hasOwn.call( obj, key ); + }, + + isEmptyObject: function( obj ) { + for ( var name in obj ) { + return false; + } + return true; + }, + + error: function( msg ) { + throw new Error( msg ); + }, + + parseJSON: function( data ) { + if ( typeof data !== "string" || !data ) { + return null; + } + + // Make sure leading/trailing whitespace is removed (IE can't handle it) + data = jQuery.trim( data ); + + // Attempt to parse using the native JSON parser first + if ( window.JSON && window.JSON.parse ) { + return window.JSON.parse( data ); + } + + // Make sure the incoming data is actual JSON + // Logic borrowed from http://json.org/json2.js + if ( rvalidchars.test( data.replace( rvalidescape, "@" ) + .replace( rvalidtokens, "]" ) + .replace( rvalidbraces, "")) ) { + + return ( new Function( "return " + data ) )(); + + } + jQuery.error( "Invalid JSON: " + data ); + }, + + // Cross-browser xml parsing + parseXML: function( data ) { + if ( typeof data !== "string" || !data ) { + return null; + } + var xml, tmp; + try { + if ( window.DOMParser ) { // Standard + tmp = new DOMParser(); + xml = tmp.parseFromString( data , "text/xml" ); + } else { // IE + xml = new ActiveXObject( "Microsoft.XMLDOM" ); + xml.async = "false"; + xml.loadXML( data ); + } + } catch( e ) { + xml = undefined; + } + if ( !xml || !xml.documentElement || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; + }, + + noop: function() {}, + + // Evaluates a script in a global context + // Workarounds based on findings by Jim Driscoll + // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context + globalEval: function( data ) { + if ( data && rnotwhite.test( data ) ) { + // We use execScript on Internet Explorer + // We use an anonymous function so that context is window + // rather than jQuery in Firefox + ( window.execScript || function( data ) { + window[ "eval" ].call( window, data ); + } )( data ); + } + }, + + // Convert dashed to camelCase; used by the css and data modules + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + nodeName: function( elem, name ) { + return elem.nodeName && elem.nodeName.toUpperCase() === name.toUpperCase(); + }, + + // args is for internal usage only + each: function( object, callback, args ) { + var name, i = 0, + length = object.length, + isObj = length === undefined || jQuery.isFunction( object ); + + if ( args ) { + if ( isObj ) { + for ( name in object ) { + if ( callback.apply( object[ name ], args ) === false ) { + break; + } + } + } else { + for ( ; i < length; ) { + if ( callback.apply( object[ i++ ], args ) === false ) { + break; + } + } + } + + // A special, fast, case for the most common use of each + } else { + if ( isObj ) { + for ( name in object ) { + if ( callback.call( object[ name ], name, object[ name ] ) === false ) { + break; + } + } + } else { + for ( ; i < length; ) { + if ( callback.call( object[ i ], i, object[ i++ ] ) === false ) { + break; + } + } + } + } + + return object; + }, + + // Use native String.trim function wherever possible + trim: trim ? + function( text ) { + return text == null ? + "" : + trim.call( text ); + } : + + // Otherwise use our own trimming functionality + function( text ) { + return text == null ? + "" : + text.toString().replace( trimLeft, "" ).replace( trimRight, "" ); + }, + + // results is for internal usage only + makeArray: function( array, results ) { + var ret = results || []; + + if ( array != null ) { + // The window, strings (and functions) also have 'length' + // Tweaked logic slightly to handle Blackberry 4.7 RegExp issues #6930 + var type = jQuery.type( array ); + + if ( array.length == null || type === "string" || type === "function" || type === "regexp" || jQuery.isWindow( array ) ) { + push.call( ret, array ); + } else { + jQuery.merge( ret, array ); + } + } + + return ret; + }, + + inArray: function( elem, array, i ) { + var len; + + if ( array ) { + if ( indexOf ) { + return indexOf.call( array, elem, i ); + } + + len = array.length; + i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0; + + for ( ; i < len; i++ ) { + // Skip accessing in sparse arrays + if ( i in array && array[ i ] === elem ) { + return i; + } + } + } + + return -1; + }, + + merge: function( first, second ) { + var i = first.length, + j = 0; + + if ( typeof second.length === "number" ) { + for ( var l = second.length; j < l; j++ ) { + first[ i++ ] = second[ j ]; + } + + } else { + while ( second[j] !== undefined ) { + first[ i++ ] = second[ j++ ]; + } + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, inv ) { + var ret = [], retVal; + inv = !!inv; + + // Go through the array, only saving the items + // that pass the validator function + for ( var i = 0, length = elems.length; i < length; i++ ) { + retVal = !!callback( elems[ i ], i ); + if ( inv !== retVal ) { + ret.push( elems[ i ] ); + } + } + + return ret; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var value, key, ret = [], + i = 0, + length = elems.length, + // jquery objects are treated as arrays + isArray = elems instanceof jQuery || length !== undefined && typeof length === "number" && ( ( length > 0 && elems[ 0 ] && elems[ length -1 ] ) || length === 0 || jQuery.isArray( elems ) ) ; + + // Go through the array, translating each of the items to their + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + + // Go through every key on the object, + } else { + for ( key in elems ) { + value = callback( elems[ key ], key, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + } + + // Flatten any nested arrays + return ret.concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + if ( typeof context === "string" ) { + var tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + var args = slice.call( arguments, 2 ), + proxy = function() { + return fn.apply( context, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || proxy.guid || jQuery.guid++; + + return proxy; + }, + + // Mutifunctional method to get and set values to a collection + // The value/s can optionally be executed if it's a function + access: function( elems, fn, key, value, chainable, emptyGet, pass ) { + var exec, + bulk = key == null, + i = 0, + length = elems.length; + + // Sets many values + if ( key && typeof key === "object" ) { + for ( i in key ) { + jQuery.access( elems, fn, i, key[i], 1, emptyGet, value ); + } + chainable = 1; + + // Sets one value + } else if ( value !== undefined ) { + // Optionally, function values get executed if exec is true + exec = pass === undefined && jQuery.isFunction( value ); + + if ( bulk ) { + // Bulk operations only iterate when executing function values + if ( exec ) { + exec = fn; + fn = function( elem, key, value ) { + return exec.call( jQuery( elem ), value ); + }; + + // Otherwise they run against the entire set + } else { + fn.call( elems, value ); + fn = null; + } + } + + if ( fn ) { + for (; i < length; i++ ) { + fn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass ); + } + } + + chainable = 1; + } + + return chainable ? + elems : + + // Gets + bulk ? + fn.call( elems ) : + length ? fn( elems[0], key ) : emptyGet; + }, + + now: function() { + return ( new Date() ).getTime(); + }, + + // Use of jQuery.browser is frowned upon. + // More details: http://docs.jquery.com/Utilities/jQuery.browser + uaMatch: function( ua ) { + ua = ua.toLowerCase(); + + var match = rwebkit.exec( ua ) || + ropera.exec( ua ) || + rmsie.exec( ua ) || + ua.indexOf("compatible") < 0 && rmozilla.exec( ua ) || + []; + + return { browser: match[1] || "", version: match[2] || "0" }; + }, + + sub: function() { + function jQuerySub( selector, context ) { + return new jQuerySub.fn.init( selector, context ); + } + jQuery.extend( true, jQuerySub, this ); + jQuerySub.superclass = this; + jQuerySub.fn = jQuerySub.prototype = this(); + jQuerySub.fn.constructor = jQuerySub; + jQuerySub.sub = this.sub; + jQuerySub.fn.init = function init( selector, context ) { + if ( context && context instanceof jQuery && !(context instanceof jQuerySub) ) { + context = jQuerySub( context ); + } + + return jQuery.fn.init.call( this, selector, context, rootjQuerySub ); + }; + jQuerySub.fn.init.prototype = jQuerySub.fn; + var rootjQuerySub = jQuerySub(document); + return jQuerySub; + }, + + browser: {} +}); + +// Populate the class2type map +jQuery.each("Boolean Number String Function Array Date RegExp Object".split(" "), function(i, name) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +}); + +browserMatch = jQuery.uaMatch( userAgent ); +if ( browserMatch.browser ) { + jQuery.browser[ browserMatch.browser ] = true; + jQuery.browser.version = browserMatch.version; +} + +// Deprecated, use jQuery.browser.webkit instead +if ( jQuery.browser.webkit ) { + jQuery.browser.safari = true; +} + +// IE doesn't match non-breaking spaces with \s +if ( rnotwhite.test( "\xA0" ) ) { + trimLeft = /^[\s\xA0]+/; + trimRight = /[\s\xA0]+$/; +} + +// All jQuery objects should point back to these +rootjQuery = jQuery(document); + +// Cleanup functions for the document ready method +if ( document.addEventListener ) { + DOMContentLoaded = function() { + document.removeEventListener( "DOMContentLoaded", DOMContentLoaded, false ); + jQuery.ready(); + }; + +} else if ( document.attachEvent ) { + DOMContentLoaded = function() { + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( document.readyState === "complete" ) { + document.detachEvent( "onreadystatechange", DOMContentLoaded ); + jQuery.ready(); + } + }; +} + +// The DOM ready check for Internet Explorer +function doScrollCheck() { + if ( jQuery.isReady ) { + return; + } + + try { + // If IE is used, use the trick by Diego Perini + // http://javascript.nwbox.com/IEContentLoaded/ + document.documentElement.doScroll("left"); + } catch(e) { + setTimeout( doScrollCheck, 1 ); + return; + } + + // and execute any waiting functions + jQuery.ready(); +} + +return jQuery; + +})(); + + +// String to Object flags format cache +var flagsCache = {}; + +// Convert String-formatted flags into Object-formatted ones and store in cache +function createFlags( flags ) { + var object = flagsCache[ flags ] = {}, + i, length; + flags = flags.split( /\s+/ ); + for ( i = 0, length = flags.length; i < length; i++ ) { + object[ flags[i] ] = true; + } + return object; +} + +/* + * Create a callback list using the following parameters: + * + * flags: an optional list of space-separated flags that will change how + * the callback list behaves + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible flags: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( flags ) { + + // Convert flags from String-formatted to Object-formatted + // (we check in cache first) + flags = flags ? ( flagsCache[ flags ] || createFlags( flags ) ) : {}; + + var // Actual callback list + list = [], + // Stack of fire calls for repeatable lists + stack = [], + // Last fire value (for non-forgettable lists) + memory, + // Flag to know if list was already fired + fired, + // Flag to know if list is currently firing + firing, + // First callback to fire (used internally by add and fireWith) + firingStart, + // End of the loop when firing + firingLength, + // Index of currently firing callback (modified by remove if needed) + firingIndex, + // Add one or several callbacks to the list + add = function( args ) { + var i, + length, + elem, + type, + actual; + for ( i = 0, length = args.length; i < length; i++ ) { + elem = args[ i ]; + type = jQuery.type( elem ); + if ( type === "array" ) { + // Inspect recursively + add( elem ); + } else if ( type === "function" ) { + // Add if not in unique mode and callback is not in + if ( !flags.unique || !self.has( elem ) ) { + list.push( elem ); + } + } + } + }, + // Fire callbacks + fire = function( context, args ) { + args = args || []; + memory = !flags.memory || [ context, args ]; + fired = true; + firing = true; + firingIndex = firingStart || 0; + firingStart = 0; + firingLength = list.length; + for ( ; list && firingIndex < firingLength; firingIndex++ ) { + if ( list[ firingIndex ].apply( context, args ) === false && flags.stopOnFalse ) { + memory = true; // Mark as halted + break; + } + } + firing = false; + if ( list ) { + if ( !flags.once ) { + if ( stack && stack.length ) { + memory = stack.shift(); + self.fireWith( memory[ 0 ], memory[ 1 ] ); + } + } else if ( memory === true ) { + self.disable(); + } else { + list = []; + } + } + }, + // Actual Callbacks object + self = { + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + var length = list.length; + add( arguments ); + // Do we need to add the callbacks to the + // current firing batch? + if ( firing ) { + firingLength = list.length; + // With memory, if we're not firing then + // we should call right away, unless previous + // firing was halted (stopOnFalse) + } else if ( memory && memory !== true ) { + firingStart = length; + fire( memory[ 0 ], memory[ 1 ] ); + } + } + return this; + }, + // Remove a callback from the list + remove: function() { + if ( list ) { + var args = arguments, + argIndex = 0, + argLength = args.length; + for ( ; argIndex < argLength ; argIndex++ ) { + for ( var i = 0; i < list.length; i++ ) { + if ( args[ argIndex ] === list[ i ] ) { + // Handle firingIndex and firingLength + if ( firing ) { + if ( i <= firingLength ) { + firingLength--; + if ( i <= firingIndex ) { + firingIndex--; + } + } + } + // Remove the element + list.splice( i--, 1 ); + // If we have some unicity property then + // we only need to do this once + if ( flags.unique ) { + break; + } + } + } + } + } + return this; + }, + // Control if a given callback is in the list + has: function( fn ) { + if ( list ) { + var i = 0, + length = list.length; + for ( ; i < length; i++ ) { + if ( fn === list[ i ] ) { + return true; + } + } + } + return false; + }, + // Remove all callbacks from the list + empty: function() { + list = []; + return this; + }, + // Have the list do nothing anymore + disable: function() { + list = stack = memory = undefined; + return this; + }, + // Is it disabled? + disabled: function() { + return !list; + }, + // Lock the list in its current state + lock: function() { + stack = undefined; + if ( !memory || memory === true ) { + self.disable(); + } + return this; + }, + // Is it locked? + locked: function() { + return !stack; + }, + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( stack ) { + if ( firing ) { + if ( !flags.once ) { + stack.push( [ context, args ] ); + } + } else if ( !( flags.once && memory ) ) { + fire( context, args ); + } + } + return this; + }, + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + + + +var // Static reference to slice + sliceDeferred = [].slice; + +jQuery.extend({ + + Deferred: function( func ) { + var doneList = jQuery.Callbacks( "once memory" ), + failList = jQuery.Callbacks( "once memory" ), + progressList = jQuery.Callbacks( "memory" ), + state = "pending", + lists = { + resolve: doneList, + reject: failList, + notify: progressList + }, + promise = { + done: doneList.add, + fail: failList.add, + progress: progressList.add, + + state: function() { + return state; + }, + + // Deprecated + isResolved: doneList.fired, + isRejected: failList.fired, + + then: function( doneCallbacks, failCallbacks, progressCallbacks ) { + deferred.done( doneCallbacks ).fail( failCallbacks ).progress( progressCallbacks ); + return this; + }, + always: function() { + deferred.done.apply( deferred, arguments ).fail.apply( deferred, arguments ); + return this; + }, + pipe: function( fnDone, fnFail, fnProgress ) { + return jQuery.Deferred(function( newDefer ) { + jQuery.each( { + done: [ fnDone, "resolve" ], + fail: [ fnFail, "reject" ], + progress: [ fnProgress, "notify" ] + }, function( handler, data ) { + var fn = data[ 0 ], + action = data[ 1 ], + returned; + if ( jQuery.isFunction( fn ) ) { + deferred[ handler ](function() { + returned = fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise().then( newDefer.resolve, newDefer.reject, newDefer.notify ); + } else { + newDefer[ action + "With" ]( this === deferred ? newDefer : this, [ returned ] ); + } + }); + } else { + deferred[ handler ]( newDefer[ action ] ); + } + }); + }).promise(); + }, + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + if ( obj == null ) { + obj = promise; + } else { + for ( var key in promise ) { + obj[ key ] = promise[ key ]; + } + } + return obj; + } + }, + deferred = promise.promise({}), + key; + + for ( key in lists ) { + deferred[ key ] = lists[ key ].fire; + deferred[ key + "With" ] = lists[ key ].fireWith; + } + + // Handle state + deferred.done( function() { + state = "resolved"; + }, failList.disable, progressList.lock ).fail( function() { + state = "rejected"; + }, doneList.disable, progressList.lock ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( firstParam ) { + var args = sliceDeferred.call( arguments, 0 ), + i = 0, + length = args.length, + pValues = new Array( length ), + count = length, + pCount = length, + deferred = length <= 1 && firstParam && jQuery.isFunction( firstParam.promise ) ? + firstParam : + jQuery.Deferred(), + promise = deferred.promise(); + function resolveFunc( i ) { + return function( value ) { + args[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value; + if ( !( --count ) ) { + deferred.resolveWith( deferred, args ); + } + }; + } + function progressFunc( i ) { + return function( value ) { + pValues[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value; + deferred.notifyWith( promise, pValues ); + }; + } + if ( length > 1 ) { + for ( ; i < length; i++ ) { + if ( args[ i ] && args[ i ].promise && jQuery.isFunction( args[ i ].promise ) ) { + args[ i ].promise().then( resolveFunc(i), deferred.reject, progressFunc(i) ); + } else { + --count; + } + } + if ( !count ) { + deferred.resolveWith( deferred, args ); + } + } else if ( deferred !== firstParam ) { + deferred.resolveWith( deferred, length ? [ firstParam ] : [] ); + } + return promise; + } +}); + + + + +jQuery.support = (function() { + + var support, + all, + a, + select, + opt, + input, + fragment, + tds, + events, + eventName, + i, + isSupported, + div = document.createElement( "div" ), + documentElement = document.documentElement; + + // Preliminary tests + div.setAttribute("className", "t"); + div.innerHTML = "
    a"; + + all = div.getElementsByTagName( "*" ); + a = div.getElementsByTagName( "a" )[ 0 ]; + + // Can't get basic test support + if ( !all || !all.length || !a ) { + return {}; + } + + // First batch of supports tests + select = document.createElement( "select" ); + opt = select.appendChild( document.createElement("option") ); + input = div.getElementsByTagName( "input" )[ 0 ]; + + support = { + // IE strips leading whitespace when .innerHTML is used + leadingWhitespace: ( div.firstChild.nodeType === 3 ), + + // Make sure that tbody elements aren't automatically inserted + // IE will insert them into empty tables + tbody: !div.getElementsByTagName("tbody").length, + + // Make sure that link elements get serialized correctly by innerHTML + // This requires a wrapper element in IE + htmlSerialize: !!div.getElementsByTagName("link").length, + + // Get the style information from getAttribute + // (IE uses .cssText instead) + style: /top/.test( a.getAttribute("style") ), + + // Make sure that URLs aren't manipulated + // (IE normalizes it by default) + hrefNormalized: ( a.getAttribute("href") === "/a" ), + + // Make sure that element opacity exists + // (IE uses filter instead) + // Use a regex to work around a WebKit issue. See #5145 + opacity: /^0.55/.test( a.style.opacity ), + + // Verify style float existence + // (IE uses styleFloat instead of cssFloat) + cssFloat: !!a.style.cssFloat, + + // Make sure that if no value is specified for a checkbox + // that it defaults to "on". + // (WebKit defaults to "" instead) + checkOn: ( input.value === "on" ), + + // Make sure that a selected-by-default option has a working selected property. + // (WebKit defaults to false instead of true, IE too, if it's in an optgroup) + optSelected: opt.selected, + + // Test setAttribute on camelCase class. If it works, we need attrFixes when doing get/setAttribute (ie6/7) + getSetAttribute: div.className !== "t", + + // Tests for enctype support on a form(#6743) + enctype: !!document.createElement("form").enctype, + + // Makes sure cloning an html5 element does not cause problems + // Where outerHTML is undefined, this still works + html5Clone: document.createElement("nav").cloneNode( true ).outerHTML !== "<:nav>", + + // Will be defined later + submitBubbles: true, + changeBubbles: true, + focusinBubbles: false, + deleteExpando: true, + noCloneEvent: true, + inlineBlockNeedsLayout: false, + shrinkWrapBlocks: false, + reliableMarginRight: true, + pixelMargin: true + }; + + // jQuery.boxModel DEPRECATED in 1.3, use jQuery.support.boxModel instead + jQuery.boxModel = support.boxModel = (document.compatMode === "CSS1Compat"); + + // Make sure checked status is properly cloned + input.checked = true; + support.noCloneChecked = input.cloneNode( true ).checked; + + // Make sure that the options inside disabled selects aren't marked as disabled + // (WebKit marks them as disabled) + select.disabled = true; + support.optDisabled = !opt.disabled; + + // Test to see if it's possible to delete an expando from an element + // Fails in Internet Explorer + try { + delete div.test; + } catch( e ) { + support.deleteExpando = false; + } + + if ( !div.addEventListener && div.attachEvent && div.fireEvent ) { + div.attachEvent( "onclick", function() { + // Cloning a node shouldn't copy over any + // bound event handlers (IE does this) + support.noCloneEvent = false; + }); + div.cloneNode( true ).fireEvent( "onclick" ); + } + + // Check if a radio maintains its value + // after being appended to the DOM + input = document.createElement("input"); + input.value = "t"; + input.setAttribute("type", "radio"); + support.radioValue = input.value === "t"; + + input.setAttribute("checked", "checked"); + + // #11217 - WebKit loses check when the name is after the checked attribute + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + fragment = document.createDocumentFragment(); + fragment.appendChild( div.lastChild ); + + // WebKit doesn't clone checked state correctly in fragments + support.checkClone = fragment.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Check if a disconnected checkbox will retain its checked + // value of true after appended to the DOM (IE6/7) + support.appendChecked = input.checked; + + fragment.removeChild( input ); + fragment.appendChild( div ); + + // Technique from Juriy Zaytsev + // http://perfectionkills.com/detecting-event-support-without-browser-sniffing/ + // We only care about the case where non-standard event systems + // are used, namely in IE. Short-circuiting here helps us to + // avoid an eval call (in setAttribute) which can cause CSP + // to go haywire. See: https://developer.mozilla.org/en/Security/CSP + if ( div.attachEvent ) { + for ( i in { + submit: 1, + change: 1, + focusin: 1 + }) { + eventName = "on" + i; + isSupported = ( eventName in div ); + if ( !isSupported ) { + div.setAttribute( eventName, "return;" ); + isSupported = ( typeof div[ eventName ] === "function" ); + } + support[ i + "Bubbles" ] = isSupported; + } + } + + fragment.removeChild( div ); + + // Null elements to avoid leaks in IE + fragment = select = opt = div = input = null; + + // Run tests that need a body at doc ready + jQuery(function() { + var container, outer, inner, table, td, offsetSupport, + marginDiv, conMarginTop, style, html, positionTopLeftWidthHeight, + paddingMarginBorderVisibility, paddingMarginBorder, + body = document.getElementsByTagName("body")[0]; + + if ( !body ) { + // Return for frameset docs that don't have a body + return; + } + + conMarginTop = 1; + paddingMarginBorder = "padding:0;margin:0;border:"; + positionTopLeftWidthHeight = "position:absolute;top:0;left:0;width:1px;height:1px;"; + paddingMarginBorderVisibility = paddingMarginBorder + "0;visibility:hidden;"; + style = "style='" + positionTopLeftWidthHeight + paddingMarginBorder + "5px solid #000;"; + html = "
    " + + "" + + "
    "; + + container = document.createElement("div"); + container.style.cssText = paddingMarginBorderVisibility + "width:0;height:0;position:static;top:0;margin-top:" + conMarginTop + "px"; + body.insertBefore( container, body.firstChild ); + + // Construct the test element + div = document.createElement("div"); + container.appendChild( div ); + + // Check if table cells still have offsetWidth/Height when they are set + // to display:none and there are still other visible table cells in a + // table row; if so, offsetWidth/Height are not reliable for use when + // determining if an element has been hidden directly using + // display:none (it is still safe to use offsets if a parent element is + // hidden; don safety goggles and see bug #4512 for more information). + // (only IE 8 fails this test) + div.innerHTML = "
    t
    "; + tds = div.getElementsByTagName( "td" ); + isSupported = ( tds[ 0 ].offsetHeight === 0 ); + + tds[ 0 ].style.display = ""; + tds[ 1 ].style.display = "none"; + + // Check if empty table cells still have offsetWidth/Height + // (IE <= 8 fail this test) + support.reliableHiddenOffsets = isSupported && ( tds[ 0 ].offsetHeight === 0 ); + + // Check if div with explicit width and no margin-right incorrectly + // gets computed margin-right based on width of container. For more + // info see bug #3333 + // Fails in WebKit before Feb 2011 nightlies + // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right + if ( window.getComputedStyle ) { + div.innerHTML = ""; + marginDiv = document.createElement( "div" ); + marginDiv.style.width = "0"; + marginDiv.style.marginRight = "0"; + div.style.width = "2px"; + div.appendChild( marginDiv ); + support.reliableMarginRight = + ( parseInt( ( window.getComputedStyle( marginDiv, null ) || { marginRight: 0 } ).marginRight, 10 ) || 0 ) === 0; + } + + if ( typeof div.style.zoom !== "undefined" ) { + // Check if natively block-level elements act like inline-block + // elements when setting their display to 'inline' and giving + // them layout + // (IE < 8 does this) + div.innerHTML = ""; + div.style.width = div.style.padding = "1px"; + div.style.border = 0; + div.style.overflow = "hidden"; + div.style.display = "inline"; + div.style.zoom = 1; + support.inlineBlockNeedsLayout = ( div.offsetWidth === 3 ); + + // Check if elements with layout shrink-wrap their children + // (IE 6 does this) + div.style.display = "block"; + div.style.overflow = "visible"; + div.innerHTML = "
    "; + support.shrinkWrapBlocks = ( div.offsetWidth !== 3 ); + } + + div.style.cssText = positionTopLeftWidthHeight + paddingMarginBorderVisibility; + div.innerHTML = html; + + outer = div.firstChild; + inner = outer.firstChild; + td = outer.nextSibling.firstChild.firstChild; + + offsetSupport = { + doesNotAddBorder: ( inner.offsetTop !== 5 ), + doesAddBorderForTableAndCells: ( td.offsetTop === 5 ) + }; + + inner.style.position = "fixed"; + inner.style.top = "20px"; + + // safari subtracts parent border width here which is 5px + offsetSupport.fixedPosition = ( inner.offsetTop === 20 || inner.offsetTop === 15 ); + inner.style.position = inner.style.top = ""; + + outer.style.overflow = "hidden"; + outer.style.position = "relative"; + + offsetSupport.subtractsBorderForOverflowNotVisible = ( inner.offsetTop === -5 ); + offsetSupport.doesNotIncludeMarginInBodyOffset = ( body.offsetTop !== conMarginTop ); + + if ( window.getComputedStyle ) { + div.style.marginTop = "1%"; + support.pixelMargin = ( window.getComputedStyle( div, null ) || { marginTop: 0 } ).marginTop !== "1%"; + } + + if ( typeof container.style.zoom !== "undefined" ) { + container.style.zoom = 1; + } + + body.removeChild( container ); + marginDiv = div = container = null; + + jQuery.extend( support, offsetSupport ); + }); + + return support; +})(); + + + + +var rbrace = /^(?:\{.*\}|\[.*\])$/, + rmultiDash = /([A-Z])/g; + +jQuery.extend({ + cache: {}, + + // Please use with caution + uuid: 0, + + // Unique for each copy of jQuery on the page + // Non-digits removed to match rinlinejQuery + expando: "jQuery" + ( jQuery.fn.jquery + Math.random() ).replace( /\D/g, "" ), + + // The following elements throw uncatchable exceptions if you + // attempt to add expando properties to them. + noData: { + "embed": true, + // Ban all objects except for Flash (which handle expandos) + "object": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000", + "applet": true + }, + + hasData: function( elem ) { + elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ]; + return !!elem && !isEmptyDataObject( elem ); + }, + + data: function( elem, name, data, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var privateCache, thisCache, ret, + internalKey = jQuery.expando, + getByName = typeof name === "string", + + // We have to handle DOM nodes and JS objects differently because IE6-7 + // can't GC object references properly across the DOM-JS boundary + isNode = elem.nodeType, + + // Only DOM nodes need the global jQuery cache; JS object data is + // attached directly to the object so GC can occur automatically + cache = isNode ? jQuery.cache : elem, + + // Only defining an ID for JS objects if its cache already exists allows + // the code to shortcut on the same path as a DOM node with no cache + id = isNode ? elem[ internalKey ] : elem[ internalKey ] && internalKey, + isEvents = name === "events"; + + // Avoid doing any more work than we need to when trying to get data on an + // object that has no data at all + if ( (!id || !cache[id] || (!isEvents && !pvt && !cache[id].data)) && getByName && data === undefined ) { + return; + } + + if ( !id ) { + // Only DOM nodes need a new unique ID for each element since their data + // ends up in the global cache + if ( isNode ) { + elem[ internalKey ] = id = ++jQuery.uuid; + } else { + id = internalKey; + } + } + + if ( !cache[ id ] ) { + cache[ id ] = {}; + + // Avoids exposing jQuery metadata on plain JS objects when the object + // is serialized using JSON.stringify + if ( !isNode ) { + cache[ id ].toJSON = jQuery.noop; + } + } + + // An object can be passed to jQuery.data instead of a key/value pair; this gets + // shallow copied over onto the existing cache + if ( typeof name === "object" || typeof name === "function" ) { + if ( pvt ) { + cache[ id ] = jQuery.extend( cache[ id ], name ); + } else { + cache[ id ].data = jQuery.extend( cache[ id ].data, name ); + } + } + + privateCache = thisCache = cache[ id ]; + + // jQuery data() is stored in a separate object inside the object's internal data + // cache in order to avoid key collisions between internal data and user-defined + // data. + if ( !pvt ) { + if ( !thisCache.data ) { + thisCache.data = {}; + } + + thisCache = thisCache.data; + } + + if ( data !== undefined ) { + thisCache[ jQuery.camelCase( name ) ] = data; + } + + // Users should not attempt to inspect the internal events object using jQuery.data, + // it is undocumented and subject to change. But does anyone listen? No. + if ( isEvents && !thisCache[ name ] ) { + return privateCache.events; + } + + // Check for both converted-to-camel and non-converted data property names + // If a data property was specified + if ( getByName ) { + + // First Try to find as-is property data + ret = thisCache[ name ]; + + // Test for null|undefined property data + if ( ret == null ) { + + // Try to find the camelCased property + ret = thisCache[ jQuery.camelCase( name ) ]; + } + } else { + ret = thisCache; + } + + return ret; + }, + + removeData: function( elem, name, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var thisCache, i, l, + + // Reference to internal data cache key + internalKey = jQuery.expando, + + isNode = elem.nodeType, + + // See jQuery.data for more information + cache = isNode ? jQuery.cache : elem, + + // See jQuery.data for more information + id = isNode ? elem[ internalKey ] : internalKey; + + // If there is already no cache entry for this object, there is no + // purpose in continuing + if ( !cache[ id ] ) { + return; + } + + if ( name ) { + + thisCache = pvt ? cache[ id ] : cache[ id ].data; + + if ( thisCache ) { + + // Support array or space separated string names for data keys + if ( !jQuery.isArray( name ) ) { + + // try the string as a key before any manipulation + if ( name in thisCache ) { + name = [ name ]; + } else { + + // split the camel cased version by spaces unless a key with the spaces exists + name = jQuery.camelCase( name ); + if ( name in thisCache ) { + name = [ name ]; + } else { + name = name.split( " " ); + } + } + } + + for ( i = 0, l = name.length; i < l; i++ ) { + delete thisCache[ name[i] ]; + } + + // If there is no data left in the cache, we want to continue + // and let the cache object itself get destroyed + if ( !( pvt ? isEmptyDataObject : jQuery.isEmptyObject )( thisCache ) ) { + return; + } + } + } + + // See jQuery.data for more information + if ( !pvt ) { + delete cache[ id ].data; + + // Don't destroy the parent cache unless the internal data object + // had been the only thing left in it + if ( !isEmptyDataObject(cache[ id ]) ) { + return; + } + } + + // Browsers that fail expando deletion also refuse to delete expandos on + // the window, but it will allow it on all other JS objects; other browsers + // don't care + // Ensure that `cache` is not a window object #10080 + if ( jQuery.support.deleteExpando || !cache.setInterval ) { + delete cache[ id ]; + } else { + cache[ id ] = null; + } + + // We destroyed the cache and need to eliminate the expando on the node to avoid + // false lookups in the cache for entries that no longer exist + if ( isNode ) { + // IE does not allow us to delete expando properties from nodes, + // nor does it have a removeAttribute function on Document nodes; + // we must handle all of these cases + if ( jQuery.support.deleteExpando ) { + delete elem[ internalKey ]; + } else if ( elem.removeAttribute ) { + elem.removeAttribute( internalKey ); + } else { + elem[ internalKey ] = null; + } + } + }, + + // For internal use only. + _data: function( elem, name, data ) { + return jQuery.data( elem, name, data, true ); + }, + + // A method for determining if a DOM node can handle the data expando + acceptData: function( elem ) { + if ( elem.nodeName ) { + var match = jQuery.noData[ elem.nodeName.toLowerCase() ]; + + if ( match ) { + return !(match === true || elem.getAttribute("classid") !== match); + } + } + + return true; + } +}); + +jQuery.fn.extend({ + data: function( key, value ) { + var parts, part, attr, name, l, + elem = this[0], + i = 0, + data = null; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = jQuery.data( elem ); + + if ( elem.nodeType === 1 && !jQuery._data( elem, "parsedAttrs" ) ) { + attr = elem.attributes; + for ( l = attr.length; i < l; i++ ) { + name = attr[i].name; + + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.substring(5) ); + + dataAttr( elem, name, data[ name ] ); + } + } + jQuery._data( elem, "parsedAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each(function() { + jQuery.data( this, key ); + }); + } + + parts = key.split( ".", 2 ); + parts[1] = parts[1] ? "." + parts[1] : ""; + part = parts[1] + "!"; + + return jQuery.access( this, function( value ) { + + if ( value === undefined ) { + data = this.triggerHandler( "getData" + part, [ parts[0] ] ); + + // Try to fetch any internally stored data first + if ( data === undefined && elem ) { + data = jQuery.data( elem, key ); + data = dataAttr( elem, key, data ); + } + + return data === undefined && parts[1] ? + this.data( parts[0] ) : + data; + } + + parts[1] = value; + this.each(function() { + var self = jQuery( this ); + + self.triggerHandler( "setData" + part, parts ); + jQuery.data( this, key, value ); + self.triggerHandler( "changeData" + part, parts ); + }); + }, null, value, arguments.length > 1, null, false ); + }, + + removeData: function( key ) { + return this.each(function() { + jQuery.removeData( this, key ); + }); + } +}); + +function dataAttr( elem, key, data ) { + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + + var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); + + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = data === "true" ? true : + data === "false" ? false : + data === "null" ? null : + jQuery.isNumeric( data ) ? +data : + rbrace.test( data ) ? jQuery.parseJSON( data ) : + data; + } catch( e ) {} + + // Make sure we set the data so it isn't changed later + jQuery.data( elem, key, data ); + + } else { + data = undefined; + } + } + + return data; +} + +// checks a cache object for emptiness +function isEmptyDataObject( obj ) { + for ( var name in obj ) { + + // if the public data object is empty, the private is still empty + if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) { + continue; + } + if ( name !== "toJSON" ) { + return false; + } + } + + return true; +} + + + + +function handleQueueMarkDefer( elem, type, src ) { + var deferDataKey = type + "defer", + queueDataKey = type + "queue", + markDataKey = type + "mark", + defer = jQuery._data( elem, deferDataKey ); + if ( defer && + ( src === "queue" || !jQuery._data(elem, queueDataKey) ) && + ( src === "mark" || !jQuery._data(elem, markDataKey) ) ) { + // Give room for hard-coded callbacks to fire first + // and eventually mark/queue something else on the element + setTimeout( function() { + if ( !jQuery._data( elem, queueDataKey ) && + !jQuery._data( elem, markDataKey ) ) { + jQuery.removeData( elem, deferDataKey, true ); + defer.fire(); + } + }, 0 ); + } +} + +jQuery.extend({ + + _mark: function( elem, type ) { + if ( elem ) { + type = ( type || "fx" ) + "mark"; + jQuery._data( elem, type, (jQuery._data( elem, type ) || 0) + 1 ); + } + }, + + _unmark: function( force, elem, type ) { + if ( force !== true ) { + type = elem; + elem = force; + force = false; + } + if ( elem ) { + type = type || "fx"; + var key = type + "mark", + count = force ? 0 : ( (jQuery._data( elem, key ) || 1) - 1 ); + if ( count ) { + jQuery._data( elem, key, count ); + } else { + jQuery.removeData( elem, key, true ); + handleQueueMarkDefer( elem, type, "mark" ); + } + } + }, + + queue: function( elem, type, data ) { + var q; + if ( elem ) { + type = ( type || "fx" ) + "queue"; + q = jQuery._data( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !q || jQuery.isArray(data) ) { + q = jQuery._data( elem, type, jQuery.makeArray(data) ); + } else { + q.push( data ); + } + } + return q || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + fn = queue.shift(), + hooks = {}; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + } + + if ( fn ) { + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + jQuery._data( elem, type + ".run", hooks ); + fn.call( elem, function() { + jQuery.dequeue( elem, type ); + }, hooks ); + } + + if ( !queue.length ) { + jQuery.removeData( elem, type + "queue " + type + ".run", true ); + handleQueueMarkDefer( elem, type, "queue" ); + } + } +}); + +jQuery.fn.extend({ + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[0], type ); + } + + return data === undefined ? + this : + this.each(function() { + var queue = jQuery.queue( this, type, data ); + + if ( type === "fx" && queue[0] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + }); + }, + dequeue: function( type ) { + return this.each(function() { + jQuery.dequeue( this, type ); + }); + }, + // Based off of the plugin by Clint Helfers, with permission. + // http://blindsignals.com/index.php/2009/07/jquery-delay/ + delay: function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = setTimeout( next, time ); + hooks.stop = function() { + clearTimeout( timeout ); + }; + }); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, object ) { + if ( typeof type !== "string" ) { + object = type; + type = undefined; + } + type = type || "fx"; + var defer = jQuery.Deferred(), + elements = this, + i = elements.length, + count = 1, + deferDataKey = type + "defer", + queueDataKey = type + "queue", + markDataKey = type + "mark", + tmp; + function resolve() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + } + while( i-- ) { + if (( tmp = jQuery.data( elements[ i ], deferDataKey, undefined, true ) || + ( jQuery.data( elements[ i ], queueDataKey, undefined, true ) || + jQuery.data( elements[ i ], markDataKey, undefined, true ) ) && + jQuery.data( elements[ i ], deferDataKey, jQuery.Callbacks( "once memory" ), true ) )) { + count++; + tmp.add( resolve ); + } + } + resolve(); + return defer.promise( object ); + } +}); + + + + +var rclass = /[\n\t\r]/g, + rspace = /\s+/, + rreturn = /\r/g, + rtype = /^(?:button|input)$/i, + rfocusable = /^(?:button|input|object|select|textarea)$/i, + rclickable = /^a(?:rea)?$/i, + rboolean = /^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i, + getSetAttribute = jQuery.support.getSetAttribute, + nodeHook, boolHook, fixSpecified; + +jQuery.fn.extend({ + attr: function( name, value ) { + return jQuery.access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each(function() { + jQuery.removeAttr( this, name ); + }); + }, + + prop: function( name, value ) { + return jQuery.access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + name = jQuery.propFix[ name ] || name; + return this.each(function() { + // try/catch handles cases where IE balks (such as removing a property on window) + try { + this[ name ] = undefined; + delete this[ name ]; + } catch( e ) {} + }); + }, + + addClass: function( value ) { + var classNames, i, l, elem, + setClass, c, cl; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).addClass( value.call(this, j, this.className) ); + }); + } + + if ( value && typeof value === "string" ) { + classNames = value.split( rspace ); + + for ( i = 0, l = this.length; i < l; i++ ) { + elem = this[ i ]; + + if ( elem.nodeType === 1 ) { + if ( !elem.className && classNames.length === 1 ) { + elem.className = value; + + } else { + setClass = " " + elem.className + " "; + + for ( c = 0, cl = classNames.length; c < cl; c++ ) { + if ( !~setClass.indexOf( " " + classNames[ c ] + " " ) ) { + setClass += classNames[ c ] + " "; + } + } + elem.className = jQuery.trim( setClass ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classNames, i, l, elem, className, c, cl; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).removeClass( value.call(this, j, this.className) ); + }); + } + + if ( (value && typeof value === "string") || value === undefined ) { + classNames = ( value || "" ).split( rspace ); + + for ( i = 0, l = this.length; i < l; i++ ) { + elem = this[ i ]; + + if ( elem.nodeType === 1 && elem.className ) { + if ( value ) { + className = (" " + elem.className + " ").replace( rclass, " " ); + for ( c = 0, cl = classNames.length; c < cl; c++ ) { + className = className.replace(" " + classNames[ c ] + " ", " "); + } + elem.className = jQuery.trim( className ); + + } else { + elem.className = ""; + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isBool = typeof stateVal === "boolean"; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( i ) { + jQuery( this ).toggleClass( value.call(this, i, this.className, stateVal), stateVal ); + }); + } + + return this.each(function() { + if ( type === "string" ) { + // toggle individual class names + var className, + i = 0, + self = jQuery( this ), + state = stateVal, + classNames = value.split( rspace ); + + while ( (className = classNames[ i++ ]) ) { + // check each className given, space seperated list + state = isBool ? state : !self.hasClass( className ); + self[ state ? "addClass" : "removeClass" ]( className ); + } + + } else if ( type === "undefined" || type === "boolean" ) { + if ( this.className ) { + // store className if set + jQuery._data( this, "__className__", this.className ); + } + + // toggle whole className + this.className = this.className || value === false ? "" : jQuery._data( this, "__className__" ) || ""; + } + }); + }, + + hasClass: function( selector ) { + var className = " " + selector + " ", + i = 0, + l = this.length; + for ( ; i < l; i++ ) { + if ( this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) > -1 ) { + return true; + } + } + + return false; + }, + + val: function( value ) { + var hooks, ret, isFunction, + elem = this[0]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && "get" in hooks && (ret = hooks.get( elem, "value" )) !== undefined ) { + return ret; + } + + ret = elem.value; + + return typeof ret === "string" ? + // handle most common string cases + ret.replace(rreturn, "") : + // handle cases where value is null/undef or number + ret == null ? "" : ret; + } + + return; + } + + isFunction = jQuery.isFunction( value ); + + return this.each(function( i ) { + var self = jQuery(this), val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, self.val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + } else if ( typeof val === "number" ) { + val += ""; + } else if ( jQuery.isArray( val ) ) { + val = jQuery.map(val, function ( value ) { + return value == null ? "" : value + ""; + }); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !("set" in hooks) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + }); + } +}); + +jQuery.extend({ + valHooks: { + option: { + get: function( elem ) { + // attributes.value is undefined in Blackberry 4.7 but + // uses .value. See #6932 + var val = elem.attributes.value; + return !val || val.specified ? elem.value : elem.text; + } + }, + select: { + get: function( elem ) { + var value, i, max, option, + index = elem.selectedIndex, + values = [], + options = elem.options, + one = elem.type === "select-one"; + + // Nothing was selected + if ( index < 0 ) { + return null; + } + + // Loop through all the selected options + i = one ? index : 0; + max = one ? index + 1 : options.length; + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Don't return options that are disabled or in a disabled optgroup + if ( option.selected && (jQuery.support.optDisabled ? !option.disabled : option.getAttribute("disabled") === null) && + (!option.parentNode.disabled || !jQuery.nodeName( option.parentNode, "optgroup" )) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + // Fixes Bug #2551 -- select.val() broken in IE after form.reset() + if ( one && !values.length && options.length ) { + return jQuery( options[ index ] ).val(); + } + + return values; + }, + + set: function( elem, value ) { + var values = jQuery.makeArray( value ); + + jQuery(elem).find("option").each(function() { + this.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0; + }); + + if ( !values.length ) { + elem.selectedIndex = -1; + } + return values; + } + } + }, + + attrFn: { + val: true, + css: true, + html: true, + text: true, + data: true, + width: true, + height: true, + offset: true + }, + + attr: function( elem, name, value, pass ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set attributes on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( pass && name in jQuery.attrFn ) { + return jQuery( elem )[ name ]( value ); + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + // All attributes are lowercase + // Grab necessary hook if one is defined + if ( notxml ) { + name = name.toLowerCase(); + hooks = jQuery.attrHooks[ name ] || ( rboolean.test( name ) ? boolHook : nodeHook ); + } + + if ( value !== undefined ) { + + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + + } else if ( hooks && "set" in hooks && notxml && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + elem.setAttribute( name, "" + value ); + return value; + } + + } else if ( hooks && "get" in hooks && notxml && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + + ret = elem.getAttribute( name ); + + // Non-existent attributes return null, we normalize to undefined + return ret === null ? + undefined : + ret; + } + }, + + removeAttr: function( elem, value ) { + var propName, attrNames, name, l, isBool, + i = 0; + + if ( value && elem.nodeType === 1 ) { + attrNames = value.toLowerCase().split( rspace ); + l = attrNames.length; + + for ( ; i < l; i++ ) { + name = attrNames[ i ]; + + if ( name ) { + propName = jQuery.propFix[ name ] || name; + isBool = rboolean.test( name ); + + // See #9699 for explanation of this approach (setting first, then removal) + // Do not do this for boolean attributes (see #10870) + if ( !isBool ) { + jQuery.attr( elem, name, "" ); + } + elem.removeAttribute( getSetAttribute ? name : propName ); + + // Set corresponding property to false for boolean attributes + if ( isBool && propName in elem ) { + elem[ propName ] = false; + } + } + } + } + }, + + attrHooks: { + type: { + set: function( elem, value ) { + // We can't allow the type property to be changed (since it causes problems in IE) + if ( rtype.test( elem.nodeName ) && elem.parentNode ) { + jQuery.error( "type property can't be changed" ); + } else if ( !jQuery.support.radioValue && value === "radio" && jQuery.nodeName(elem, "input") ) { + // Setting the type on a radio button after the value resets the value in IE6-9 + // Reset value to it's default in case type is set after value + // This is for element creation + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + }, + // Use the value property for back compat + // Use the nodeHook for button elements in IE6/7 (#1954) + value: { + get: function( elem, name ) { + if ( nodeHook && jQuery.nodeName( elem, "button" ) ) { + return nodeHook.get( elem, name ); + } + return name in elem ? + elem.value : + null; + }, + set: function( elem, value, name ) { + if ( nodeHook && jQuery.nodeName( elem, "button" ) ) { + return nodeHook.set( elem, value, name ); + } + // Does not return so that setAttribute is also used + elem.value = value; + } + } + }, + + propFix: { + tabindex: "tabIndex", + readonly: "readOnly", + "for": "htmlFor", + "class": "className", + maxlength: "maxLength", + cellspacing: "cellSpacing", + cellpadding: "cellPadding", + rowspan: "rowSpan", + colspan: "colSpan", + usemap: "useMap", + frameborder: "frameBorder", + contenteditable: "contentEditable" + }, + + prop: function( elem, name, value ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set properties on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + if ( notxml ) { + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + return ( elem[ name ] = value ); + } + + } else { + if ( hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + return elem[ name ]; + } + } + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + // elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set + // http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + var attributeNode = elem.getAttributeNode("tabindex"); + + return attributeNode && attributeNode.specified ? + parseInt( attributeNode.value, 10 ) : + rfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ? + 0 : + undefined; + } + } + } +}); + +// Add the tabIndex propHook to attrHooks for back-compat (different case is intentional) +jQuery.attrHooks.tabindex = jQuery.propHooks.tabIndex; + +// Hook for boolean attributes +boolHook = { + get: function( elem, name ) { + // Align boolean attributes with corresponding properties + // Fall back to attribute presence where some booleans are not supported + var attrNode, + property = jQuery.prop( elem, name ); + return property === true || typeof property !== "boolean" && ( attrNode = elem.getAttributeNode(name) ) && attrNode.nodeValue !== false ? + name.toLowerCase() : + undefined; + }, + set: function( elem, value, name ) { + var propName; + if ( value === false ) { + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + // value is true since we know at this point it's type boolean and not false + // Set boolean attributes to the same name and set the DOM property + propName = jQuery.propFix[ name ] || name; + if ( propName in elem ) { + // Only set the IDL specifically if it already exists on the element + elem[ propName ] = true; + } + + elem.setAttribute( name, name.toLowerCase() ); + } + return name; + } +}; + +// IE6/7 do not support getting/setting some attributes with get/setAttribute +if ( !getSetAttribute ) { + + fixSpecified = { + name: true, + id: true, + coords: true + }; + + // Use this for any attribute in IE6/7 + // This fixes almost every IE6/7 issue + nodeHook = jQuery.valHooks.button = { + get: function( elem, name ) { + var ret; + ret = elem.getAttributeNode( name ); + return ret && ( fixSpecified[ name ] ? ret.nodeValue !== "" : ret.specified ) ? + ret.nodeValue : + undefined; + }, + set: function( elem, value, name ) { + // Set the existing or create a new attribute node + var ret = elem.getAttributeNode( name ); + if ( !ret ) { + ret = document.createAttribute( name ); + elem.setAttributeNode( ret ); + } + return ( ret.nodeValue = value + "" ); + } + }; + + // Apply the nodeHook to tabindex + jQuery.attrHooks.tabindex.set = nodeHook.set; + + // Set width and height to auto instead of 0 on empty string( Bug #8150 ) + // This is for removals + jQuery.each([ "width", "height" ], function( i, name ) { + jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], { + set: function( elem, value ) { + if ( value === "" ) { + elem.setAttribute( name, "auto" ); + return value; + } + } + }); + }); + + // Set contenteditable to false on removals(#10429) + // Setting to empty string throws an error as an invalid value + jQuery.attrHooks.contenteditable = { + get: nodeHook.get, + set: function( elem, value, name ) { + if ( value === "" ) { + value = "false"; + } + nodeHook.set( elem, value, name ); + } + }; +} + + +// Some attributes require a special call on IE +if ( !jQuery.support.hrefNormalized ) { + jQuery.each([ "href", "src", "width", "height" ], function( i, name ) { + jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], { + get: function( elem ) { + var ret = elem.getAttribute( name, 2 ); + return ret === null ? undefined : ret; + } + }); + }); +} + +if ( !jQuery.support.style ) { + jQuery.attrHooks.style = { + get: function( elem ) { + // Return undefined in the case of empty string + // Normalize to lowercase since IE uppercases css property names + return elem.style.cssText.toLowerCase() || undefined; + }, + set: function( elem, value ) { + return ( elem.style.cssText = "" + value ); + } + }; +} + +// Safari mis-reports the default selected property of an option +// Accessing the parent's selectedIndex property fixes it +if ( !jQuery.support.optSelected ) { + jQuery.propHooks.selected = jQuery.extend( jQuery.propHooks.selected, { + get: function( elem ) { + var parent = elem.parentNode; + + if ( parent ) { + parent.selectedIndex; + + // Make sure that it also works with optgroups, see #5701 + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + return null; + } + }); +} + +// IE6/7 call enctype encoding +if ( !jQuery.support.enctype ) { + jQuery.propFix.enctype = "encoding"; +} + +// Radios and checkboxes getter/setter +if ( !jQuery.support.checkOn ) { + jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + get: function( elem ) { + // Handle the case where in Webkit "" is returned instead of "on" if a value isn't specified + return elem.getAttribute("value") === null ? "on" : elem.value; + } + }; + }); +} +jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = jQuery.extend( jQuery.valHooks[ this ], { + set: function( elem, value ) { + if ( jQuery.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery(elem).val(), value ) >= 0 ); + } + } + }); +}); + + + + +var rformElems = /^(?:textarea|input|select)$/i, + rtypenamespace = /^([^\.]*)?(?:\.(.+))?$/, + rhoverHack = /(?:^|\s)hover(\.\S+)?\b/, + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|contextmenu)|click/, + rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + rquickIs = /^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/, + quickParse = function( selector ) { + var quick = rquickIs.exec( selector ); + if ( quick ) { + // 0 1 2 3 + // [ _, tag, id, class ] + quick[1] = ( quick[1] || "" ).toLowerCase(); + quick[3] = quick[3] && new RegExp( "(?:^|\\s)" + quick[3] + "(?:\\s|$)" ); + } + return quick; + }, + quickIs = function( elem, m ) { + var attrs = elem.attributes || {}; + return ( + (!m[1] || elem.nodeName.toLowerCase() === m[1]) && + (!m[2] || (attrs.id || {}).value === m[2]) && + (!m[3] || m[3].test( (attrs[ "class" ] || {}).value )) + ); + }, + hoverHack = function( events ) { + return jQuery.event.special.hover ? events : events.replace( rhoverHack, "mouseenter$1 mouseleave$1" ); + }; + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + add: function( elem, types, handler, data, selector ) { + + var elemData, eventHandle, events, + t, tns, type, namespaces, handleObj, + handleObjIn, quick, handlers, special; + + // Don't attach events to noData or text/comment nodes (allow plain objects tho) + if ( elem.nodeType === 3 || elem.nodeType === 8 || !types || !handler || !(elemData = jQuery._data( elem )) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + events = elemData.events; + if ( !events ) { + elemData.events = events = {}; + } + eventHandle = elemData.handle; + if ( !eventHandle ) { + elemData.handle = eventHandle = function( e ) { + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && (!e || jQuery.event.triggered !== e.type) ? + jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : + undefined; + }; + // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events + eventHandle.elem = elem; + } + + // Handle multiple events separated by a space + // jQuery(...).bind("mouseover mouseout", fn); + types = jQuery.trim( hoverHack(types) ).split( " " ); + for ( t = 0; t < types.length; t++ ) { + + tns = rtypenamespace.exec( types[t] ) || []; + type = tns[1]; + namespaces = ( tns[2] || "" ).split( "." ).sort(); + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend({ + type: type, + origType: tns[1], + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + quick: selector && quickParse( selector ), + namespace: namespaces.join(".") + }, handleObjIn ); + + // Init the event handler queue if we're the first + handlers = events[ type ]; + if ( !handlers ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener/attachEvent if the special events handler returns false + if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + // Bind the global event handler to the element + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle, false ); + + } else if ( elem.attachEvent ) { + elem.attachEvent( "on" + type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + // Nullify elem to prevent memory leaks in IE + elem = null; + }, + + global: {}, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var elemData = jQuery.hasData( elem ) && jQuery._data( elem ), + t, tns, type, origType, namespaces, origCount, + j, events, special, handle, eventType, handleObj; + + if ( !elemData || !(events = elemData.events) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = jQuery.trim( hoverHack( types || "" ) ).split(" "); + for ( t = 0; t < types.length; t++ ) { + tns = rtypenamespace.exec( types[t] ) || []; + type = origType = tns[1]; + namespaces = tns[2]; + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector? special.delegateType : special.bindType ) || type; + eventType = events[ type ] || []; + origCount = eventType.length; + namespaces = namespaces ? new RegExp("(^|\\.)" + namespaces.split(".").sort().join("\\.(?:.*\\.)?") + "(\\.|$)") : null; + + // Remove matching events + for ( j = 0; j < eventType.length; j++ ) { + handleObj = eventType[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !namespaces || namespaces.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { + eventType.splice( j--, 1 ); + + if ( handleObj.selector ) { + eventType.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( eventType.length === 0 && origCount !== eventType.length ) { + if ( !special.teardown || special.teardown.call( elem, namespaces ) === false ) { + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + handle = elemData.handle; + if ( handle ) { + handle.elem = null; + } + + // removeData also checks for emptiness and clears the expando if empty + // so use it instead of delete + jQuery.removeData( elem, [ "events", "handle" ], true ); + } + }, + + // Events that are safe to short-circuit if no handlers are attached. + // Native DOM events should not be added, they may have inline handlers. + customEvent: { + "getData": true, + "setData": true, + "changeData": true + }, + + trigger: function( event, data, elem, onlyHandlers ) { + // Don't do events on text and comment nodes + if ( elem && (elem.nodeType === 3 || elem.nodeType === 8) ) { + return; + } + + // Event object or event type + var type = event.type || event, + namespaces = [], + cache, exclusive, i, cur, old, ontype, special, handle, eventPath, bubbleType; + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "!" ) >= 0 ) { + // Exclusive events trigger only for the exact event (no namespaces) + type = type.slice(0, -1); + exclusive = true; + } + + if ( type.indexOf( "." ) >= 0 ) { + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split("."); + type = namespaces.shift(); + namespaces.sort(); + } + + if ( (!elem || jQuery.event.customEvent[ type ]) && !jQuery.event.global[ type ] ) { + // No jQuery handlers for this event type, and it can't have inline handlers + return; + } + + // Caller can pass in an Event, Object, or just an event type string + event = typeof event === "object" ? + // jQuery.Event object + event[ jQuery.expando ] ? event : + // Object literal + new jQuery.Event( type, event ) : + // Just the event type (string) + new jQuery.Event( type ); + + event.type = type; + event.isTrigger = true; + event.exclusive = exclusive; + event.namespace = namespaces.join( "." ); + event.namespace_re = event.namespace? new RegExp("(^|\\.)" + namespaces.join("\\.(?:.*\\.)?") + "(\\.|$)") : null; + ontype = type.indexOf( ":" ) < 0 ? "on" + type : ""; + + // Handle a global trigger + if ( !elem ) { + + // TODO: Stop taunting the data cache; remove global events and always attach to document + cache = jQuery.cache; + for ( i in cache ) { + if ( cache[ i ].events && cache[ i ].events[ type ] ) { + jQuery.event.trigger( event, data, cache[ i ].handle.elem, true ); + } + } + return; + } + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data != null ? jQuery.makeArray( data ) : []; + data.unshift( event ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + eventPath = [[ elem, special.bindType || type ]]; + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + cur = rfocusMorph.test( bubbleType + type ) ? elem : elem.parentNode; + old = null; + for ( ; cur; cur = cur.parentNode ) { + eventPath.push([ cur, bubbleType ]); + old = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( old && old === elem.ownerDocument ) { + eventPath.push([ old.defaultView || old.parentWindow || window, bubbleType ]); + } + } + + // Fire handlers on the event path + for ( i = 0; i < eventPath.length && !event.isPropagationStopped(); i++ ) { + + cur = eventPath[i][0]; + event.type = eventPath[i][1]; + + handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + // Note that this is a bare JS function and not a jQuery handler + handle = ontype && cur[ ontype ]; + if ( handle && jQuery.acceptData( cur ) && handle.apply( cur, data ) === false ) { + event.preventDefault(); + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( (!special._default || special._default.apply( elem.ownerDocument, data ) === false) && + !(type === "click" && jQuery.nodeName( elem, "a" )) && jQuery.acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name name as the event. + // Can't use an .isFunction() check here because IE6/7 fails that test. + // Don't do default actions on window, that's where global variables be (#6170) + // IE<9 dies on focus/blur to hidden element (#1486) + if ( ontype && elem[ type ] && ((type !== "focus" && type !== "blur") || event.target.offsetWidth !== 0) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + old = elem[ ontype ]; + + if ( old ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( old ) { + elem[ ontype ] = old; + } + } + } + } + + return event.result; + }, + + dispatch: function( event ) { + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( event || window.event ); + + var handlers = ( (jQuery._data( this, "events" ) || {} )[ event.type ] || []), + delegateCount = handlers.delegateCount, + args = [].slice.call( arguments, 0 ), + run_all = !event.exclusive && !event.namespace, + special = jQuery.event.special[ event.type ] || {}, + handlerQueue = [], + i, j, cur, jqcur, ret, selMatch, matched, matches, handleObj, sel, related; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[0] = event; + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers that should run if there are delegated events + // Avoid non-left-click bubbling in Firefox (#3861) + if ( delegateCount && !(event.button && event.type === "click") ) { + + // Pregenerate a single jQuery object for reuse with .is() + jqcur = jQuery(this); + jqcur.context = this.ownerDocument || this; + + for ( cur = event.target; cur != this; cur = cur.parentNode || this ) { + + // Don't process events on disabled elements (#6911, #8165) + if ( cur.disabled !== true ) { + selMatch = {}; + matches = []; + jqcur[0] = cur; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + sel = handleObj.selector; + + if ( selMatch[ sel ] === undefined ) { + selMatch[ sel ] = ( + handleObj.quick ? quickIs( cur, handleObj.quick ) : jqcur.is( sel ) + ); + } + if ( selMatch[ sel ] ) { + matches.push( handleObj ); + } + } + if ( matches.length ) { + handlerQueue.push({ elem: cur, matches: matches }); + } + } + } + } + + // Add the remaining (directly-bound) handlers + if ( handlers.length > delegateCount ) { + handlerQueue.push({ elem: this, matches: handlers.slice( delegateCount ) }); + } + + // Run delegates first; they may want to stop propagation beneath us + for ( i = 0; i < handlerQueue.length && !event.isPropagationStopped(); i++ ) { + matched = handlerQueue[ i ]; + event.currentTarget = matched.elem; + + for ( j = 0; j < matched.matches.length && !event.isImmediatePropagationStopped(); j++ ) { + handleObj = matched.matches[ j ]; + + // Triggered event must either 1) be non-exclusive and have no namespace, or + // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). + if ( run_all || (!event.namespace && !handleObj.namespace) || event.namespace_re && event.namespace_re.test( handleObj.namespace ) ) { + + event.data = handleObj.data; + event.handleObj = handleObj; + + ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) + .apply( matched.elem, args ); + + if ( ret !== undefined ) { + event.result = ret; + if ( ret === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + // Includes some event props shared by KeyEvent and MouseEvent + // *** attrChange attrName relatedNode srcElement are not normalized, non-W3C, deprecated, will be removed in 1.8 *** + props: "attrChange attrName relatedNode srcElement altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), + + fixHooks: {}, + + keyHooks: { + props: "char charCode key keyCode".split(" "), + filter: function( event, original ) { + + // Add which for key events + if ( event.which == null ) { + event.which = original.charCode != null ? original.charCode : original.keyCode; + } + + return event; + } + }, + + mouseHooks: { + props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "), + filter: function( event, original ) { + var eventDoc, doc, body, + button = original.button, + fromElement = original.fromElement; + + // Calculate pageX/Y if missing and clientX/Y available + if ( event.pageX == null && original.clientX != null ) { + eventDoc = event.target.ownerDocument || document; + doc = eventDoc.documentElement; + body = eventDoc.body; + + event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); + event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); + } + + // Add relatedTarget, if necessary + if ( !event.relatedTarget && fromElement ) { + event.relatedTarget = fromElement === event.target ? original.toElement : fromElement; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + // Note: button is not normalized, so don't use it + if ( !event.which && button !== undefined ) { + event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); + } + + return event; + } + }, + + fix: function( event ) { + if ( event[ jQuery.expando ] ) { + return event; + } + + // Create a writable copy of the event object and normalize some properties + var i, prop, + originalEvent = event, + fixHook = jQuery.event.fixHooks[ event.type ] || {}, + copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; + + event = jQuery.Event( originalEvent ); + + for ( i = copy.length; i; ) { + prop = copy[ --i ]; + event[ prop ] = originalEvent[ prop ]; + } + + // Fix target property, if necessary (#1925, IE 6/7/8 & Safari2) + if ( !event.target ) { + event.target = originalEvent.srcElement || document; + } + + // Target should not be a text node (#504, Safari) + if ( event.target.nodeType === 3 ) { + event.target = event.target.parentNode; + } + + // For mouse/key events; add metaKey if it's not there (#3368, IE6/7/8) + if ( event.metaKey === undefined ) { + event.metaKey = event.ctrlKey; + } + + return fixHook.filter? fixHook.filter( event, originalEvent ) : event; + }, + + special: { + ready: { + // Make sure the ready event is setup + setup: jQuery.bindReady + }, + + load: { + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + + focus: { + delegateType: "focusin" + }, + blur: { + delegateType: "focusout" + }, + + beforeunload: { + setup: function( data, namespaces, eventHandle ) { + // We only want to do this special case on windows + if ( jQuery.isWindow( this ) ) { + this.onbeforeunload = eventHandle; + } + }, + + teardown: function( namespaces, eventHandle ) { + if ( this.onbeforeunload === eventHandle ) { + this.onbeforeunload = null; + } + } + } + }, + + simulate: function( type, elem, event, bubble ) { + // Piggyback on a donor event to simulate a different one. + // Fake originalEvent to avoid donor's stopPropagation, but if the + // simulated event prevents default then we do the same on the donor. + var e = jQuery.extend( + new jQuery.Event(), + event, + { type: type, + isSimulated: true, + originalEvent: {} + } + ); + if ( bubble ) { + jQuery.event.trigger( e, null, elem ); + } else { + jQuery.event.dispatch.call( elem, e ); + } + if ( e.isDefaultPrevented() ) { + event.preventDefault(); + } + } +}; + +// Some plugins are using, but it's undocumented/deprecated and will be removed. +// The 1.7 special event interface should provide all the hooks needed now. +jQuery.event.handle = jQuery.event.dispatch; + +jQuery.removeEvent = document.removeEventListener ? + function( elem, type, handle ) { + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle, false ); + } + } : + function( elem, type, handle ) { + if ( elem.detachEvent ) { + elem.detachEvent( "on" + type, handle ); + } + }; + +jQuery.Event = function( src, props ) { + // Allow instantiation without the 'new' keyword + if ( !(this instanceof jQuery.Event) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = ( src.defaultPrevented || src.returnValue === false || + src.getPreventDefault && src.getPreventDefault() ) ? returnTrue : returnFalse; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +function returnFalse() { + return false; +} +function returnTrue() { + return true; +} + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + preventDefault: function() { + this.isDefaultPrevented = returnTrue; + + var e = this.originalEvent; + if ( !e ) { + return; + } + + // if preventDefault exists run it on the original event + if ( e.preventDefault ) { + e.preventDefault(); + + // otherwise set the returnValue property of the original event to false (IE) + } else { + e.returnValue = false; + } + }, + stopPropagation: function() { + this.isPropagationStopped = returnTrue; + + var e = this.originalEvent; + if ( !e ) { + return; + } + // if stopPropagation exists run it on the original event + if ( e.stopPropagation ) { + e.stopPropagation(); + } + // otherwise set the cancelBubble property of the original event to true (IE) + e.cancelBubble = true; + }, + stopImmediatePropagation: function() { + this.isImmediatePropagationStopped = returnTrue; + this.stopPropagation(); + }, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse +}; + +// Create mouseenter/leave events using mouseover/out and event-time checks +jQuery.each({ + mouseenter: "mouseover", + mouseleave: "mouseout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var target = this, + related = event.relatedTarget, + handleObj = event.handleObj, + selector = handleObj.selector, + ret; + + // For mousenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || (related !== target && !jQuery.contains( target, related )) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +}); + +// IE submit delegation +if ( !jQuery.support.submitBubbles ) { + + jQuery.event.special.submit = { + setup: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Lazy-add a submit handler when a descendant form may potentially be submitted + jQuery.event.add( this, "click._submit keypress._submit", function( e ) { + // Node name check avoids a VML-related crash in IE (#9807) + var elem = e.target, + form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined; + if ( form && !form._submit_attached ) { + jQuery.event.add( form, "submit._submit", function( event ) { + event._submit_bubble = true; + }); + form._submit_attached = true; + } + }); + // return undefined since we don't need an event listener + }, + + postDispatch: function( event ) { + // If form was submitted by the user, bubble the event up the tree + if ( event._submit_bubble ) { + delete event._submit_bubble; + if ( this.parentNode && !event.isTrigger ) { + jQuery.event.simulate( "submit", this.parentNode, event, true ); + } + } + }, + + teardown: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Remove delegated handlers; cleanData eventually reaps submit handlers attached above + jQuery.event.remove( this, "._submit" ); + } + }; +} + +// IE change delegation and checkbox/radio fix +if ( !jQuery.support.changeBubbles ) { + + jQuery.event.special.change = { + + setup: function() { + + if ( rformElems.test( this.nodeName ) ) { + // IE doesn't fire change on a check/radio until blur; trigger it on click + // after a propertychange. Eat the blur-change in special.change.handle. + // This still fires onchange a second time for check/radio after blur. + if ( this.type === "checkbox" || this.type === "radio" ) { + jQuery.event.add( this, "propertychange._change", function( event ) { + if ( event.originalEvent.propertyName === "checked" ) { + this._just_changed = true; + } + }); + jQuery.event.add( this, "click._change", function( event ) { + if ( this._just_changed && !event.isTrigger ) { + this._just_changed = false; + jQuery.event.simulate( "change", this, event, true ); + } + }); + } + return false; + } + // Delegated event; lazy-add a change handler on descendant inputs + jQuery.event.add( this, "beforeactivate._change", function( e ) { + var elem = e.target; + + if ( rformElems.test( elem.nodeName ) && !elem._change_attached ) { + jQuery.event.add( elem, "change._change", function( event ) { + if ( this.parentNode && !event.isSimulated && !event.isTrigger ) { + jQuery.event.simulate( "change", this.parentNode, event, true ); + } + }); + elem._change_attached = true; + } + }); + }, + + handle: function( event ) { + var elem = event.target; + + // Swallow native change events from checkbox/radio, we already triggered them above + if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) { + return event.handleObj.handler.apply( this, arguments ); + } + }, + + teardown: function() { + jQuery.event.remove( this, "._change" ); + + return rformElems.test( this.nodeName ); + } + }; +} + +// Create "bubbling" focus and blur events +if ( !jQuery.support.focusinBubbles ) { + jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler while someone wants focusin/focusout + var attaches = 0, + handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + if ( attaches++ === 0 ) { + document.addEventListener( orig, handler, true ); + } + }, + teardown: function() { + if ( --attaches === 0 ) { + document.removeEventListener( orig, handler, true ); + } + } + }; + }); +} + +jQuery.fn.extend({ + + on: function( types, selector, data, fn, /*INTERNAL*/ one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { // && selector != null + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + this.on( type, selector, data, types[ type ], one ); + } + return this; + } + + if ( data == null && fn == null ) { + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return this; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return this.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + }); + }, + one: function( types, selector, data, fn ) { + return this.on( types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + if ( types && types.preventDefault && types.handleObj ) { + // ( event ) dispatched jQuery.Event + var handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + // ( types-object [, selector] ) + for ( var type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each(function() { + jQuery.event.remove( this, types, fn, selector ); + }); + }, + + bind: function( types, data, fn ) { + return this.on( types, null, data, fn ); + }, + unbind: function( types, fn ) { + return this.off( types, null, fn ); + }, + + live: function( types, data, fn ) { + jQuery( this.context ).on( types, this.selector, data, fn ); + return this; + }, + die: function( types, fn ) { + jQuery( this.context ).off( types, this.selector || "**", fn ); + return this; + }, + + delegate: function( selector, types, data, fn ) { + return this.on( types, selector, data, fn ); + }, + undelegate: function( selector, types, fn ) { + // ( namespace ) or ( selector, types [, fn] ) + return arguments.length == 1? this.off( selector, "**" ) : this.off( types, selector, fn ); + }, + + trigger: function( type, data ) { + return this.each(function() { + jQuery.event.trigger( type, data, this ); + }); + }, + triggerHandler: function( type, data ) { + if ( this[0] ) { + return jQuery.event.trigger( type, data, this[0], true ); + } + }, + + toggle: function( fn ) { + // Save reference to arguments for access in closure + var args = arguments, + guid = fn.guid || jQuery.guid++, + i = 0, + toggler = function( event ) { + // Figure out which function to execute + var lastToggle = ( jQuery._data( this, "lastToggle" + fn.guid ) || 0 ) % i; + jQuery._data( this, "lastToggle" + fn.guid, lastToggle + 1 ); + + // Make sure that clicks stop + event.preventDefault(); + + // and execute the function + return args[ lastToggle ].apply( this, arguments ) || false; + }; + + // link all the functions, so any of them can unbind this click handler + toggler.guid = guid; + while ( i < args.length ) { + args[ i++ ].guid = guid; + } + + return this.click( toggler ); + }, + + hover: function( fnOver, fnOut ) { + return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); + } +}); + +jQuery.each( ("blur focus focusin focusout load resize scroll unload click dblclick " + + "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + + "change select submit keydown keypress keyup error contextmenu").split(" "), function( i, name ) { + + // Handle event binding + jQuery.fn[ name ] = function( data, fn ) { + if ( fn == null ) { + fn = data; + data = null; + } + + return arguments.length > 0 ? + this.on( name, null, data, fn ) : + this.trigger( name ); + }; + + if ( jQuery.attrFn ) { + jQuery.attrFn[ name ] = true; + } + + if ( rkeyEvent.test( name ) ) { + jQuery.event.fixHooks[ name ] = jQuery.event.keyHooks; + } + + if ( rmouseEvent.test( name ) ) { + jQuery.event.fixHooks[ name ] = jQuery.event.mouseHooks; + } +}); + + + +/*! + * Sizzle CSS Selector Engine + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){ + +var chunker = /((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, + expando = "sizcache" + (Math.random() + '').replace('.', ''), + done = 0, + toString = Object.prototype.toString, + hasDuplicate = false, + baseHasDuplicate = true, + rBackslash = /\\/g, + rReturn = /\r\n/g, + rNonWord = /\W/; + +// Here we check if the JavaScript engine is using some sort of +// optimization where it does not always call our comparision +// function. If that is the case, discard the hasDuplicate value. +// Thus far that includes Google Chrome. +[0, 0].sort(function() { + baseHasDuplicate = false; + return 0; +}); + +var Sizzle = function( selector, context, results, seed ) { + results = results || []; + context = context || document; + + var origContext = context; + + if ( context.nodeType !== 1 && context.nodeType !== 9 ) { + return []; + } + + if ( !selector || typeof selector !== "string" ) { + return results; + } + + var m, set, checkSet, extra, ret, cur, pop, i, + prune = true, + contextXML = Sizzle.isXML( context ), + parts = [], + soFar = selector; + + // Reset the position of the chunker regexp (start from head) + do { + chunker.exec( "" ); + m = chunker.exec( soFar ); + + if ( m ) { + soFar = m[3]; + + parts.push( m[1] ); + + if ( m[2] ) { + extra = m[3]; + break; + } + } + } while ( m ); + + if ( parts.length > 1 && origPOS.exec( selector ) ) { + + if ( parts.length === 2 && Expr.relative[ parts[0] ] ) { + set = posProcess( parts[0] + parts[1], context, seed ); + + } else { + set = Expr.relative[ parts[0] ] ? + [ context ] : + Sizzle( parts.shift(), context ); + + while ( parts.length ) { + selector = parts.shift(); + + if ( Expr.relative[ selector ] ) { + selector += parts.shift(); + } + + set = posProcess( selector, set, seed ); + } + } + + } else { + // Take a shortcut and set the context if the root selector is an ID + // (but not if it'll be faster if the inner selector is an ID) + if ( !seed && parts.length > 1 && context.nodeType === 9 && !contextXML && + Expr.match.ID.test(parts[0]) && !Expr.match.ID.test(parts[parts.length - 1]) ) { + + ret = Sizzle.find( parts.shift(), context, contextXML ); + context = ret.expr ? + Sizzle.filter( ret.expr, ret.set )[0] : + ret.set[0]; + } + + if ( context ) { + ret = seed ? + { expr: parts.pop(), set: makeArray(seed) } : + Sizzle.find( parts.pop(), parts.length === 1 && (parts[0] === "~" || parts[0] === "+") && context.parentNode ? context.parentNode : context, contextXML ); + + set = ret.expr ? + Sizzle.filter( ret.expr, ret.set ) : + ret.set; + + if ( parts.length > 0 ) { + checkSet = makeArray( set ); + + } else { + prune = false; + } + + while ( parts.length ) { + cur = parts.pop(); + pop = cur; + + if ( !Expr.relative[ cur ] ) { + cur = ""; + } else { + pop = parts.pop(); + } + + if ( pop == null ) { + pop = context; + } + + Expr.relative[ cur ]( checkSet, pop, contextXML ); + } + + } else { + checkSet = parts = []; + } + } + + if ( !checkSet ) { + checkSet = set; + } + + if ( !checkSet ) { + Sizzle.error( cur || selector ); + } + + if ( toString.call(checkSet) === "[object Array]" ) { + if ( !prune ) { + results.push.apply( results, checkSet ); + + } else if ( context && context.nodeType === 1 ) { + for ( i = 0; checkSet[i] != null; i++ ) { + if ( checkSet[i] && (checkSet[i] === true || checkSet[i].nodeType === 1 && Sizzle.contains(context, checkSet[i])) ) { + results.push( set[i] ); + } + } + + } else { + for ( i = 0; checkSet[i] != null; i++ ) { + if ( checkSet[i] && checkSet[i].nodeType === 1 ) { + results.push( set[i] ); + } + } + } + + } else { + makeArray( checkSet, results ); + } + + if ( extra ) { + Sizzle( extra, origContext, results, seed ); + Sizzle.uniqueSort( results ); + } + + return results; +}; + +Sizzle.uniqueSort = function( results ) { + if ( sortOrder ) { + hasDuplicate = baseHasDuplicate; + results.sort( sortOrder ); + + if ( hasDuplicate ) { + for ( var i = 1; i < results.length; i++ ) { + if ( results[i] === results[ i - 1 ] ) { + results.splice( i--, 1 ); + } + } + } + } + + return results; +}; + +Sizzle.matches = function( expr, set ) { + return Sizzle( expr, null, null, set ); +}; + +Sizzle.matchesSelector = function( node, expr ) { + return Sizzle( expr, null, null, [node] ).length > 0; +}; + +Sizzle.find = function( expr, context, isXML ) { + var set, i, len, match, type, left; + + if ( !expr ) { + return []; + } + + for ( i = 0, len = Expr.order.length; i < len; i++ ) { + type = Expr.order[i]; + + if ( (match = Expr.leftMatch[ type ].exec( expr )) ) { + left = match[1]; + match.splice( 1, 1 ); + + if ( left.substr( left.length - 1 ) !== "\\" ) { + match[1] = (match[1] || "").replace( rBackslash, "" ); + set = Expr.find[ type ]( match, context, isXML ); + + if ( set != null ) { + expr = expr.replace( Expr.match[ type ], "" ); + break; + } + } + } + } + + if ( !set ) { + set = typeof context.getElementsByTagName !== "undefined" ? + context.getElementsByTagName( "*" ) : + []; + } + + return { set: set, expr: expr }; +}; + +Sizzle.filter = function( expr, set, inplace, not ) { + var match, anyFound, + type, found, item, filter, left, + i, pass, + old = expr, + result = [], + curLoop = set, + isXMLFilter = set && set[0] && Sizzle.isXML( set[0] ); + + while ( expr && set.length ) { + for ( type in Expr.filter ) { + if ( (match = Expr.leftMatch[ type ].exec( expr )) != null && match[2] ) { + filter = Expr.filter[ type ]; + left = match[1]; + + anyFound = false; + + match.splice(1,1); + + if ( left.substr( left.length - 1 ) === "\\" ) { + continue; + } + + if ( curLoop === result ) { + result = []; + } + + if ( Expr.preFilter[ type ] ) { + match = Expr.preFilter[ type ]( match, curLoop, inplace, result, not, isXMLFilter ); + + if ( !match ) { + anyFound = found = true; + + } else if ( match === true ) { + continue; + } + } + + if ( match ) { + for ( i = 0; (item = curLoop[i]) != null; i++ ) { + if ( item ) { + found = filter( item, match, i, curLoop ); + pass = not ^ found; + + if ( inplace && found != null ) { + if ( pass ) { + anyFound = true; + + } else { + curLoop[i] = false; + } + + } else if ( pass ) { + result.push( item ); + anyFound = true; + } + } + } + } + + if ( found !== undefined ) { + if ( !inplace ) { + curLoop = result; + } + + expr = expr.replace( Expr.match[ type ], "" ); + + if ( !anyFound ) { + return []; + } + + break; + } + } + } + + // Improper expression + if ( expr === old ) { + if ( anyFound == null ) { + Sizzle.error( expr ); + + } else { + break; + } + } + + old = expr; + } + + return curLoop; +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Utility function for retreiving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +var getText = Sizzle.getText = function( elem ) { + var i, node, + nodeType = elem.nodeType, + ret = ""; + + if ( nodeType ) { + if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent || innerText for elements + if ( typeof elem.textContent === 'string' ) { + return elem.textContent; + } else if ( typeof elem.innerText === 'string' ) { + // Replace IE's carriage returns + return elem.innerText.replace( rReturn, '' ); + } else { + // Traverse it's children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + } else { + + // If no nodeType, this is expected to be an array + for ( i = 0; (node = elem[i]); i++ ) { + // Do not traverse comment nodes + if ( node.nodeType !== 8 ) { + ret += getText( node ); + } + } + } + return ret; +}; + +var Expr = Sizzle.selectors = { + order: [ "ID", "NAME", "TAG" ], + + match: { + ID: /#((?:[\w\u00c0-\uFFFF\-]|\\.)+)/, + CLASS: /\.((?:[\w\u00c0-\uFFFF\-]|\\.)+)/, + NAME: /\[name=['"]*((?:[\w\u00c0-\uFFFF\-]|\\.)+)['"]*\]/, + ATTR: /\[\s*((?:[\w\u00c0-\uFFFF\-]|\\.)+)\s*(?:(\S?=)\s*(?:(['"])(.*?)\3|(#?(?:[\w\u00c0-\uFFFF\-]|\\.)*)|)|)\s*\]/, + TAG: /^((?:[\w\u00c0-\uFFFF\*\-]|\\.)+)/, + CHILD: /:(only|nth|last|first)-child(?:\(\s*(even|odd|(?:[+\-]?\d+|(?:[+\-]?\d*)?n\s*(?:[+\-]\s*\d+)?))\s*\))?/, + POS: /:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^\-]|$)/, + PSEUDO: /:((?:[\w\u00c0-\uFFFF\-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/ + }, + + leftMatch: {}, + + attrMap: { + "class": "className", + "for": "htmlFor" + }, + + attrHandle: { + href: function( elem ) { + return elem.getAttribute( "href" ); + }, + type: function( elem ) { + return elem.getAttribute( "type" ); + } + }, + + relative: { + "+": function(checkSet, part){ + var isPartStr = typeof part === "string", + isTag = isPartStr && !rNonWord.test( part ), + isPartStrNotTag = isPartStr && !isTag; + + if ( isTag ) { + part = part.toLowerCase(); + } + + for ( var i = 0, l = checkSet.length, elem; i < l; i++ ) { + if ( (elem = checkSet[i]) ) { + while ( (elem = elem.previousSibling) && elem.nodeType !== 1 ) {} + + checkSet[i] = isPartStrNotTag || elem && elem.nodeName.toLowerCase() === part ? + elem || false : + elem === part; + } + } + + if ( isPartStrNotTag ) { + Sizzle.filter( part, checkSet, true ); + } + }, + + ">": function( checkSet, part ) { + var elem, + isPartStr = typeof part === "string", + i = 0, + l = checkSet.length; + + if ( isPartStr && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + + for ( ; i < l; i++ ) { + elem = checkSet[i]; + + if ( elem ) { + var parent = elem.parentNode; + checkSet[i] = parent.nodeName.toLowerCase() === part ? parent : false; + } + } + + } else { + for ( ; i < l; i++ ) { + elem = checkSet[i]; + + if ( elem ) { + checkSet[i] = isPartStr ? + elem.parentNode : + elem.parentNode === part; + } + } + + if ( isPartStr ) { + Sizzle.filter( part, checkSet, true ); + } + } + }, + + "": function(checkSet, part, isXML){ + var nodeCheck, + doneName = done++, + checkFn = dirCheck; + + if ( typeof part === "string" && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + nodeCheck = part; + checkFn = dirNodeCheck; + } + + checkFn( "parentNode", part, doneName, checkSet, nodeCheck, isXML ); + }, + + "~": function( checkSet, part, isXML ) { + var nodeCheck, + doneName = done++, + checkFn = dirCheck; + + if ( typeof part === "string" && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + nodeCheck = part; + checkFn = dirNodeCheck; + } + + checkFn( "previousSibling", part, doneName, checkSet, nodeCheck, isXML ); + } + }, + + find: { + ID: function( match, context, isXML ) { + if ( typeof context.getElementById !== "undefined" && !isXML ) { + var m = context.getElementById(match[1]); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + return m && m.parentNode ? [m] : []; + } + }, + + NAME: function( match, context ) { + if ( typeof context.getElementsByName !== "undefined" ) { + var ret = [], + results = context.getElementsByName( match[1] ); + + for ( var i = 0, l = results.length; i < l; i++ ) { + if ( results[i].getAttribute("name") === match[1] ) { + ret.push( results[i] ); + } + } + + return ret.length === 0 ? null : ret; + } + }, + + TAG: function( match, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( match[1] ); + } + } + }, + preFilter: { + CLASS: function( match, curLoop, inplace, result, not, isXML ) { + match = " " + match[1].replace( rBackslash, "" ) + " "; + + if ( isXML ) { + return match; + } + + for ( var i = 0, elem; (elem = curLoop[i]) != null; i++ ) { + if ( elem ) { + if ( not ^ (elem.className && (" " + elem.className + " ").replace(/[\t\n\r]/g, " ").indexOf(match) >= 0) ) { + if ( !inplace ) { + result.push( elem ); + } + + } else if ( inplace ) { + curLoop[i] = false; + } + } + } + + return false; + }, + + ID: function( match ) { + return match[1].replace( rBackslash, "" ); + }, + + TAG: function( match, curLoop ) { + return match[1].replace( rBackslash, "" ).toLowerCase(); + }, + + CHILD: function( match ) { + if ( match[1] === "nth" ) { + if ( !match[2] ) { + Sizzle.error( match[0] ); + } + + match[2] = match[2].replace(/^\+|\s*/g, ''); + + // parse equations like 'even', 'odd', '5', '2n', '3n+2', '4n-1', '-n+6' + var test = /(-?)(\d*)(?:n([+\-]?\d*))?/.exec( + match[2] === "even" && "2n" || match[2] === "odd" && "2n+1" || + !/\D/.test( match[2] ) && "0n+" + match[2] || match[2]); + + // calculate the numbers (first)n+(last) including if they are negative + match[2] = (test[1] + (test[2] || 1)) - 0; + match[3] = test[3] - 0; + } + else if ( match[2] ) { + Sizzle.error( match[0] ); + } + + // TODO: Move to normal caching system + match[0] = done++; + + return match; + }, + + ATTR: function( match, curLoop, inplace, result, not, isXML ) { + var name = match[1] = match[1].replace( rBackslash, "" ); + + if ( !isXML && Expr.attrMap[name] ) { + match[1] = Expr.attrMap[name]; + } + + // Handle if an un-quoted value was used + match[4] = ( match[4] || match[5] || "" ).replace( rBackslash, "" ); + + if ( match[2] === "~=" ) { + match[4] = " " + match[4] + " "; + } + + return match; + }, + + PSEUDO: function( match, curLoop, inplace, result, not ) { + if ( match[1] === "not" ) { + // If we're dealing with a complex expression, or a simple one + if ( ( chunker.exec(match[3]) || "" ).length > 1 || /^\w/.test(match[3]) ) { + match[3] = Sizzle(match[3], null, null, curLoop); + + } else { + var ret = Sizzle.filter(match[3], curLoop, inplace, true ^ not); + + if ( !inplace ) { + result.push.apply( result, ret ); + } + + return false; + } + + } else if ( Expr.match.POS.test( match[0] ) || Expr.match.CHILD.test( match[0] ) ) { + return true; + } + + return match; + }, + + POS: function( match ) { + match.unshift( true ); + + return match; + } + }, + + filters: { + enabled: function( elem ) { + return elem.disabled === false && elem.type !== "hidden"; + }, + + disabled: function( elem ) { + return elem.disabled === true; + }, + + checked: function( elem ) { + return elem.checked === true; + }, + + selected: function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + parent: function( elem ) { + return !!elem.firstChild; + }, + + empty: function( elem ) { + return !elem.firstChild; + }, + + has: function( elem, i, match ) { + return !!Sizzle( match[3], elem ).length; + }, + + header: function( elem ) { + return (/h\d/i).test( elem.nodeName ); + }, + + text: function( elem ) { + var attr = elem.getAttribute( "type" ), type = elem.type; + // IE6 and 7 will map elem.type to 'text' for new HTML5 types (search, etc) + // use getAttribute instead to test this case + return elem.nodeName.toLowerCase() === "input" && "text" === type && ( attr === type || attr === null ); + }, + + radio: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "radio" === elem.type; + }, + + checkbox: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "checkbox" === elem.type; + }, + + file: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "file" === elem.type; + }, + + password: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "password" === elem.type; + }, + + submit: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && "submit" === elem.type; + }, + + image: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "image" === elem.type; + }, + + reset: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && "reset" === elem.type; + }, + + button: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && "button" === elem.type || name === "button"; + }, + + input: function( elem ) { + return (/input|select|textarea|button/i).test( elem.nodeName ); + }, + + focus: function( elem ) { + return elem === elem.ownerDocument.activeElement; + } + }, + setFilters: { + first: function( elem, i ) { + return i === 0; + }, + + last: function( elem, i, match, array ) { + return i === array.length - 1; + }, + + even: function( elem, i ) { + return i % 2 === 0; + }, + + odd: function( elem, i ) { + return i % 2 === 1; + }, + + lt: function( elem, i, match ) { + return i < match[3] - 0; + }, + + gt: function( elem, i, match ) { + return i > match[3] - 0; + }, + + nth: function( elem, i, match ) { + return match[3] - 0 === i; + }, + + eq: function( elem, i, match ) { + return match[3] - 0 === i; + } + }, + filter: { + PSEUDO: function( elem, match, i, array ) { + var name = match[1], + filter = Expr.filters[ name ]; + + if ( filter ) { + return filter( elem, i, match, array ); + + } else if ( name === "contains" ) { + return (elem.textContent || elem.innerText || getText([ elem ]) || "").indexOf(match[3]) >= 0; + + } else if ( name === "not" ) { + var not = match[3]; + + for ( var j = 0, l = not.length; j < l; j++ ) { + if ( not[j] === elem ) { + return false; + } + } + + return true; + + } else { + Sizzle.error( name ); + } + }, + + CHILD: function( elem, match ) { + var first, last, + doneName, parent, cache, + count, diff, + type = match[1], + node = elem; + + switch ( type ) { + case "only": + case "first": + while ( (node = node.previousSibling) ) { + if ( node.nodeType === 1 ) { + return false; + } + } + + if ( type === "first" ) { + return true; + } + + node = elem; + + /* falls through */ + case "last": + while ( (node = node.nextSibling) ) { + if ( node.nodeType === 1 ) { + return false; + } + } + + return true; + + case "nth": + first = match[2]; + last = match[3]; + + if ( first === 1 && last === 0 ) { + return true; + } + + doneName = match[0]; + parent = elem.parentNode; + + if ( parent && (parent[ expando ] !== doneName || !elem.nodeIndex) ) { + count = 0; + + for ( node = parent.firstChild; node; node = node.nextSibling ) { + if ( node.nodeType === 1 ) { + node.nodeIndex = ++count; + } + } + + parent[ expando ] = doneName; + } + + diff = elem.nodeIndex - last; + + if ( first === 0 ) { + return diff === 0; + + } else { + return ( diff % first === 0 && diff / first >= 0 ); + } + } + }, + + ID: function( elem, match ) { + return elem.nodeType === 1 && elem.getAttribute("id") === match; + }, + + TAG: function( elem, match ) { + return (match === "*" && elem.nodeType === 1) || !!elem.nodeName && elem.nodeName.toLowerCase() === match; + }, + + CLASS: function( elem, match ) { + return (" " + (elem.className || elem.getAttribute("class")) + " ") + .indexOf( match ) > -1; + }, + + ATTR: function( elem, match ) { + var name = match[1], + result = Sizzle.attr ? + Sizzle.attr( elem, name ) : + Expr.attrHandle[ name ] ? + Expr.attrHandle[ name ]( elem ) : + elem[ name ] != null ? + elem[ name ] : + elem.getAttribute( name ), + value = result + "", + type = match[2], + check = match[4]; + + return result == null ? + type === "!=" : + !type && Sizzle.attr ? + result != null : + type === "=" ? + value === check : + type === "*=" ? + value.indexOf(check) >= 0 : + type === "~=" ? + (" " + value + " ").indexOf(check) >= 0 : + !check ? + value && result !== false : + type === "!=" ? + value !== check : + type === "^=" ? + value.indexOf(check) === 0 : + type === "$=" ? + value.substr(value.length - check.length) === check : + type === "|=" ? + value === check || value.substr(0, check.length + 1) === check + "-" : + false; + }, + + POS: function( elem, match, i, array ) { + var name = match[2], + filter = Expr.setFilters[ name ]; + + if ( filter ) { + return filter( elem, i, match, array ); + } + } + } +}; + +var origPOS = Expr.match.POS, + fescape = function(all, num){ + return "\\" + (num - 0 + 1); + }; + +for ( var type in Expr.match ) { + Expr.match[ type ] = new RegExp( Expr.match[ type ].source + (/(?![^\[]*\])(?![^\(]*\))/.source) ); + Expr.leftMatch[ type ] = new RegExp( /(^(?:.|\r|\n)*?)/.source + Expr.match[ type ].source.replace(/\\(\d+)/g, fescape) ); +} +// Expose origPOS +// "global" as in regardless of relation to brackets/parens +Expr.match.globalPOS = origPOS; + +var makeArray = function( array, results ) { + array = Array.prototype.slice.call( array, 0 ); + + if ( results ) { + results.push.apply( results, array ); + return results; + } + + return array; +}; + +// Perform a simple check to determine if the browser is capable of +// converting a NodeList to an array using builtin methods. +// Also verifies that the returned array holds DOM nodes +// (which is not the case in the Blackberry browser) +try { + Array.prototype.slice.call( document.documentElement.childNodes, 0 )[0].nodeType; + +// Provide a fallback method if it does not work +} catch( e ) { + makeArray = function( array, results ) { + var i = 0, + ret = results || []; + + if ( toString.call(array) === "[object Array]" ) { + Array.prototype.push.apply( ret, array ); + + } else { + if ( typeof array.length === "number" ) { + for ( var l = array.length; i < l; i++ ) { + ret.push( array[i] ); + } + + } else { + for ( ; array[i]; i++ ) { + ret.push( array[i] ); + } + } + } + + return ret; + }; +} + +var sortOrder, siblingCheck; + +if ( document.documentElement.compareDocumentPosition ) { + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + if ( !a.compareDocumentPosition || !b.compareDocumentPosition ) { + return a.compareDocumentPosition ? -1 : 1; + } + + return a.compareDocumentPosition(b) & 4 ? -1 : 1; + }; + +} else { + sortOrder = function( a, b ) { + // The nodes are identical, we can exit early + if ( a === b ) { + hasDuplicate = true; + return 0; + + // Fallback to using sourceIndex (in IE) if it's available on both nodes + } else if ( a.sourceIndex && b.sourceIndex ) { + return a.sourceIndex - b.sourceIndex; + } + + var al, bl, + ap = [], + bp = [], + aup = a.parentNode, + bup = b.parentNode, + cur = aup; + + // If the nodes are siblings (or identical) we can do a quick check + if ( aup === bup ) { + return siblingCheck( a, b ); + + // If no parents were found then the nodes are disconnected + } else if ( !aup ) { + return -1; + + } else if ( !bup ) { + return 1; + } + + // Otherwise they're somewhere else in the tree so we need + // to build up a full list of the parentNodes for comparison + while ( cur ) { + ap.unshift( cur ); + cur = cur.parentNode; + } + + cur = bup; + + while ( cur ) { + bp.unshift( cur ); + cur = cur.parentNode; + } + + al = ap.length; + bl = bp.length; + + // Start walking down the tree looking for a discrepancy + for ( var i = 0; i < al && i < bl; i++ ) { + if ( ap[i] !== bp[i] ) { + return siblingCheck( ap[i], bp[i] ); + } + } + + // We ended someplace up the tree so do a sibling check + return i === al ? + siblingCheck( a, bp[i], -1 ) : + siblingCheck( ap[i], b, 1 ); + }; + + siblingCheck = function( a, b, ret ) { + if ( a === b ) { + return ret; + } + + var cur = a.nextSibling; + + while ( cur ) { + if ( cur === b ) { + return -1; + } + + cur = cur.nextSibling; + } + + return 1; + }; +} + +// Check to see if the browser returns elements by name when +// querying by getElementById (and provide a workaround) +(function(){ + // We're going to inject a fake input element with a specified name + var form = document.createElement("div"), + id = "script" + (new Date()).getTime(), + root = document.documentElement; + + form.innerHTML = ""; + + // Inject it into the root element, check its status, and remove it quickly + root.insertBefore( form, root.firstChild ); + + // The workaround has to do additional checks after a getElementById + // Which slows things down for other browsers (hence the branching) + if ( document.getElementById( id ) ) { + Expr.find.ID = function( match, context, isXML ) { + if ( typeof context.getElementById !== "undefined" && !isXML ) { + var m = context.getElementById(match[1]); + + return m ? + m.id === match[1] || typeof m.getAttributeNode !== "undefined" && m.getAttributeNode("id").nodeValue === match[1] ? + [m] : + undefined : + []; + } + }; + + Expr.filter.ID = function( elem, match ) { + var node = typeof elem.getAttributeNode !== "undefined" && elem.getAttributeNode("id"); + + return elem.nodeType === 1 && node && node.nodeValue === match; + }; + } + + root.removeChild( form ); + + // release memory in IE + root = form = null; +})(); + +(function(){ + // Check to see if the browser returns only elements + // when doing getElementsByTagName("*") + + // Create a fake element + var div = document.createElement("div"); + div.appendChild( document.createComment("") ); + + // Make sure no comments are found + if ( div.getElementsByTagName("*").length > 0 ) { + Expr.find.TAG = function( match, context ) { + var results = context.getElementsByTagName( match[1] ); + + // Filter out possible comments + if ( match[1] === "*" ) { + var tmp = []; + + for ( var i = 0; results[i]; i++ ) { + if ( results[i].nodeType === 1 ) { + tmp.push( results[i] ); + } + } + + results = tmp; + } + + return results; + }; + } + + // Check to see if an attribute returns normalized href attributes + div.innerHTML = ""; + + if ( div.firstChild && typeof div.firstChild.getAttribute !== "undefined" && + div.firstChild.getAttribute("href") !== "#" ) { + + Expr.attrHandle.href = function( elem ) { + return elem.getAttribute( "href", 2 ); + }; + } + + // release memory in IE + div = null; +})(); + +if ( document.querySelectorAll ) { + (function(){ + var oldSizzle = Sizzle, + div = document.createElement("div"), + id = "__sizzle__"; + + div.innerHTML = "

    "; + + // Safari can't handle uppercase or unicode characters when + // in quirks mode. + if ( div.querySelectorAll && div.querySelectorAll(".TEST").length === 0 ) { + return; + } + + Sizzle = function( query, context, extra, seed ) { + context = context || document; + + // Only use querySelectorAll on non-XML documents + // (ID selectors don't work in non-HTML documents) + if ( !seed && !Sizzle.isXML(context) ) { + // See if we find a selector to speed up + var match = /^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec( query ); + + if ( match && (context.nodeType === 1 || context.nodeType === 9) ) { + // Speed-up: Sizzle("TAG") + if ( match[1] ) { + return makeArray( context.getElementsByTagName( query ), extra ); + + // Speed-up: Sizzle(".CLASS") + } else if ( match[2] && Expr.find.CLASS && context.getElementsByClassName ) { + return makeArray( context.getElementsByClassName( match[2] ), extra ); + } + } + + if ( context.nodeType === 9 ) { + // Speed-up: Sizzle("body") + // The body element only exists once, optimize finding it + if ( query === "body" && context.body ) { + return makeArray( [ context.body ], extra ); + + // Speed-up: Sizzle("#ID") + } else if ( match && match[3] ) { + var elem = context.getElementById( match[3] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id === match[3] ) { + return makeArray( [ elem ], extra ); + } + + } else { + return makeArray( [], extra ); + } + } + + try { + return makeArray( context.querySelectorAll(query), extra ); + } catch(qsaError) {} + + // qSA works strangely on Element-rooted queries + // We can work around this by specifying an extra ID on the root + // and working up from there (Thanks to Andrew Dupont for the technique) + // IE 8 doesn't work on object elements + } else if ( context.nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { + var oldContext = context, + old = context.getAttribute( "id" ), + nid = old || id, + hasParent = context.parentNode, + relativeHierarchySelector = /^\s*[+~]/.test( query ); + + if ( !old ) { + context.setAttribute( "id", nid ); + } else { + nid = nid.replace( /'/g, "\\$&" ); + } + if ( relativeHierarchySelector && hasParent ) { + context = context.parentNode; + } + + try { + if ( !relativeHierarchySelector || hasParent ) { + return makeArray( context.querySelectorAll( "[id='" + nid + "'] " + query ), extra ); + } + + } catch(pseudoError) { + } finally { + if ( !old ) { + oldContext.removeAttribute( "id" ); + } + } + } + } + + return oldSizzle(query, context, extra, seed); + }; + + for ( var prop in oldSizzle ) { + Sizzle[ prop ] = oldSizzle[ prop ]; + } + + // release memory in IE + div = null; + })(); +} + +(function(){ + var html = document.documentElement, + matches = html.matchesSelector || html.mozMatchesSelector || html.webkitMatchesSelector || html.msMatchesSelector; + + if ( matches ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9 fails this) + var disconnectedMatch = !matches.call( document.createElement( "div" ), "div" ), + pseudoWorks = false; + + try { + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( document.documentElement, "[test!='']:sizzle" ); + + } catch( pseudoError ) { + pseudoWorks = true; + } + + Sizzle.matchesSelector = function( node, expr ) { + // Make sure that attribute selectors are quoted + expr = expr.replace(/\=\s*([^'"\]]*)\s*\]/g, "='$1']"); + + if ( !Sizzle.isXML( node ) ) { + try { + if ( pseudoWorks || !Expr.match.PSEUDO.test( expr ) && !/!=/.test( expr ) ) { + var ret = matches.call( node, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || !disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9, so check for that + node.document && node.document.nodeType !== 11 ) { + return ret; + } + } + } catch(e) {} + } + + return Sizzle(expr, null, null, [node]).length > 0; + }; + } +})(); + +(function(){ + var div = document.createElement("div"); + + div.innerHTML = "
    "; + + // Opera can't find a second classname (in 9.6) + // Also, make sure that getElementsByClassName actually exists + if ( !div.getElementsByClassName || div.getElementsByClassName("e").length === 0 ) { + return; + } + + // Safari caches class attributes, doesn't catch changes (in 3.2) + div.lastChild.className = "e"; + + if ( div.getElementsByClassName("e").length === 1 ) { + return; + } + + Expr.order.splice(1, 0, "CLASS"); + Expr.find.CLASS = function( match, context, isXML ) { + if ( typeof context.getElementsByClassName !== "undefined" && !isXML ) { + return context.getElementsByClassName(match[1]); + } + }; + + // release memory in IE + div = null; +})(); + +function dirNodeCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) { + for ( var i = 0, l = checkSet.length; i < l; i++ ) { + var elem = checkSet[i]; + + if ( elem ) { + var match = false; + + elem = elem[dir]; + + while ( elem ) { + if ( elem[ expando ] === doneName ) { + match = checkSet[elem.sizset]; + break; + } + + if ( elem.nodeType === 1 && !isXML ){ + elem[ expando ] = doneName; + elem.sizset = i; + } + + if ( elem.nodeName.toLowerCase() === cur ) { + match = elem; + break; + } + + elem = elem[dir]; + } + + checkSet[i] = match; + } + } +} + +function dirCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) { + for ( var i = 0, l = checkSet.length; i < l; i++ ) { + var elem = checkSet[i]; + + if ( elem ) { + var match = false; + + elem = elem[dir]; + + while ( elem ) { + if ( elem[ expando ] === doneName ) { + match = checkSet[elem.sizset]; + break; + } + + if ( elem.nodeType === 1 ) { + if ( !isXML ) { + elem[ expando ] = doneName; + elem.sizset = i; + } + + if ( typeof cur !== "string" ) { + if ( elem === cur ) { + match = true; + break; + } + + } else if ( Sizzle.filter( cur, [elem] ).length > 0 ) { + match = elem; + break; + } + } + + elem = elem[dir]; + } + + checkSet[i] = match; + } + } +} + +if ( document.documentElement.contains ) { + Sizzle.contains = function( a, b ) { + return a !== b && (a.contains ? a.contains(b) : true); + }; + +} else if ( document.documentElement.compareDocumentPosition ) { + Sizzle.contains = function( a, b ) { + return !!(a.compareDocumentPosition(b) & 16); + }; + +} else { + Sizzle.contains = function() { + return false; + }; +} + +Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = (elem ? elem.ownerDocument || elem : 0).documentElement; + + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +var posProcess = function( selector, context, seed ) { + var match, + tmpSet = [], + later = "", + root = context.nodeType ? [context] : context; + + // Position selectors must be done after the filter + // And so must :not(positional) so we move all PSEUDOs to the end + while ( (match = Expr.match.PSEUDO.exec( selector )) ) { + later += match[0]; + selector = selector.replace( Expr.match.PSEUDO, "" ); + } + + selector = Expr.relative[selector] ? selector + "*" : selector; + + for ( var i = 0, l = root.length; i < l; i++ ) { + Sizzle( selector, root[i], tmpSet, seed ); + } + + return Sizzle.filter( later, tmpSet ); +}; + +// EXPOSE +// Override sizzle attribute retrieval +Sizzle.attr = jQuery.attr; +Sizzle.selectors.attrMap = {}; +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; +jQuery.expr[":"] = jQuery.expr.filters; +jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; + + +})(); + + +var runtil = /Until$/, + rparentsprev = /^(?:parents|prevUntil|prevAll)/, + // Note: This RegExp should be improved, or likely pulled from Sizzle + rmultiselector = /,/, + isSimple = /^.[^:#\[\.,]*$/, + slice = Array.prototype.slice, + POS = jQuery.expr.match.globalPOS, + // methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend({ + find: function( selector ) { + var self = this, + i, l; + + if ( typeof selector !== "string" ) { + return jQuery( selector ).filter(function() { + for ( i = 0, l = self.length; i < l; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + }); + } + + var ret = this.pushStack( "", "find", selector ), + length, n, r; + + for ( i = 0, l = this.length; i < l; i++ ) { + length = ret.length; + jQuery.find( selector, this[i], ret ); + + if ( i > 0 ) { + // Make sure that the results are unique + for ( n = length; n < ret.length; n++ ) { + for ( r = 0; r < length; r++ ) { + if ( ret[r] === ret[n] ) { + ret.splice(n--, 1); + break; + } + } + } + } + } + + return ret; + }, + + has: function( target ) { + var targets = jQuery( target ); + return this.filter(function() { + for ( var i = 0, l = targets.length; i < l; i++ ) { + if ( jQuery.contains( this, targets[i] ) ) { + return true; + } + } + }); + }, + + not: function( selector ) { + return this.pushStack( winnow(this, selector, false), "not", selector); + }, + + filter: function( selector ) { + return this.pushStack( winnow(this, selector, true), "filter", selector ); + }, + + is: function( selector ) { + return !!selector && ( + typeof selector === "string" ? + // If this is a positional selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + POS.test( selector ) ? + jQuery( selector, this.context ).index( this[0] ) >= 0 : + jQuery.filter( selector, this ).length > 0 : + this.filter( selector ).length > 0 ); + }, + + closest: function( selectors, context ) { + var ret = [], i, l, cur = this[0]; + + // Array (deprecated as of jQuery 1.7) + if ( jQuery.isArray( selectors ) ) { + var level = 1; + + while ( cur && cur.ownerDocument && cur !== context ) { + for ( i = 0; i < selectors.length; i++ ) { + + if ( jQuery( cur ).is( selectors[ i ] ) ) { + ret.push({ selector: selectors[ i ], elem: cur, level: level }); + } + } + + cur = cur.parentNode; + level++; + } + + return ret; + } + + // String + var pos = POS.test( selectors ) || typeof selectors !== "string" ? + jQuery( selectors, context || this.context ) : + 0; + + for ( i = 0, l = this.length; i < l; i++ ) { + cur = this[i]; + + while ( cur ) { + if ( pos ? pos.index(cur) > -1 : jQuery.find.matchesSelector(cur, selectors) ) { + ret.push( cur ); + break; + + } else { + cur = cur.parentNode; + if ( !cur || !cur.ownerDocument || cur === context || cur.nodeType === 11 ) { + break; + } + } + } + } + + ret = ret.length > 1 ? jQuery.unique( ret ) : ret; + + return this.pushStack( ret, "closest", selectors ); + }, + + // Determine the position of an element within + // the matched set of elements + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[0] && this[0].parentNode ) ? this.prevAll().length : -1; + } + + // index in selector + if ( typeof elem === "string" ) { + return jQuery.inArray( this[0], jQuery( elem ) ); + } + + // Locate the position of the desired element + return jQuery.inArray( + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[0] : elem, this ); + }, + + add: function( selector, context ) { + var set = typeof selector === "string" ? + jQuery( selector, context ) : + jQuery.makeArray( selector && selector.nodeType ? [ selector ] : selector ), + all = jQuery.merge( this.get(), set ); + + return this.pushStack( isDisconnected( set[0] ) || isDisconnected( all[0] ) ? + all : + jQuery.unique( all ) ); + }, + + andSelf: function() { + return this.add( this.prevObject ); + } +}); + +// A painfully simple check to see if an element is disconnected +// from a document (should be improved, where feasible). +function isDisconnected( node ) { + return !node || !node.parentNode || node.parentNode.nodeType === 11; +} + +jQuery.each({ + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return jQuery.dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return jQuery.dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return jQuery.nth( elem, 2, "nextSibling" ); + }, + prev: function( elem ) { + return jQuery.nth( elem, 2, "previousSibling" ); + }, + nextAll: function( elem ) { + return jQuery.dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return jQuery.dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return jQuery.dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return jQuery.dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return jQuery.sibling( elem.firstChild ); + }, + contents: function( elem ) { + return jQuery.nodeName( elem, "iframe" ) ? + elem.contentDocument || elem.contentWindow.document : + jQuery.makeArray( elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var ret = jQuery.map( this, fn, until ); + + if ( !runtil.test( name ) ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + ret = jQuery.filter( selector, ret ); + } + + ret = this.length > 1 && !guaranteedUnique[ name ] ? jQuery.unique( ret ) : ret; + + if ( (this.length > 1 || rmultiselector.test( selector )) && rparentsprev.test( name ) ) { + ret = ret.reverse(); + } + + return this.pushStack( ret, name, slice.call( arguments ).join(",") ); + }; +}); + +jQuery.extend({ + filter: function( expr, elems, not ) { + if ( not ) { + expr = ":not(" + expr + ")"; + } + + return elems.length === 1 ? + jQuery.find.matchesSelector(elems[0], expr) ? [ elems[0] ] : [] : + jQuery.find.matches(expr, elems); + }, + + dir: function( elem, dir, until ) { + var matched = [], + cur = elem[ dir ]; + + while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) { + if ( cur.nodeType === 1 ) { + matched.push( cur ); + } + cur = cur[dir]; + } + return matched; + }, + + nth: function( cur, result, dir, elem ) { + result = result || 1; + var num = 0; + + for ( ; cur; cur = cur[dir] ) { + if ( cur.nodeType === 1 && ++num === result ) { + break; + } + } + + return cur; + }, + + sibling: function( n, elem ) { + var r = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + r.push( n ); + } + } + + return r; + } +}); + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, keep ) { + + // Can't pass null or undefined to indexOf in Firefox 4 + // Set to 0 to skip string check + qualifier = qualifier || 0; + + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep(elements, function( elem, i ) { + var retVal = !!qualifier.call( elem, i, elem ); + return retVal === keep; + }); + + } else if ( qualifier.nodeType ) { + return jQuery.grep(elements, function( elem, i ) { + return ( elem === qualifier ) === keep; + }); + + } else if ( typeof qualifier === "string" ) { + var filtered = jQuery.grep(elements, function( elem ) { + return elem.nodeType === 1; + }); + + if ( isSimple.test( qualifier ) ) { + return jQuery.filter(qualifier, filtered, !keep); + } else { + qualifier = jQuery.filter( qualifier, filtered ); + } + } + + return jQuery.grep(elements, function( elem, i ) { + return ( jQuery.inArray( elem, qualifier ) >= 0 ) === keep; + }); +} + + + + +function createSafeFragment( document ) { + var list = nodeNames.split( "|" ), + safeFrag = document.createDocumentFragment(); + + if ( safeFrag.createElement ) { + while ( list.length ) { + safeFrag.createElement( + list.pop() + ); + } + } + return safeFrag; +} + +var nodeNames = "abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|" + + "header|hgroup|mark|meter|nav|output|progress|section|summary|time|video", + rinlinejQuery = / jQuery\d+="(?:\d+|null)"/g, + rleadingWhitespace = /^\s+/, + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig, + rtagName = /<([\w:]+)/, + rtbody = /]", "i"), + // checked="checked" or checked + rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, + rscriptType = /\/(java|ecma)script/i, + rcleanScript = /^\s*", "" ], + legend: [ 1, "
    ", "
    " ], + thead: [ 1, "", "
    " ], + tr: [ 2, "", "
    " ], + td: [ 3, "", "
    " ], + col: [ 2, "", "
    " ], + area: [ 1, "", "" ], + _default: [ 0, "", "" ] + }, + safeFragment = createSafeFragment( document ); + +wrapMap.optgroup = wrapMap.option; +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// IE can't serialize and + + + + + diff --git a/foreman/3.16/apidoc/v2/architectures.html b/foreman/3.16/apidoc/v2/architectures.html new file mode 100644 index 00000000..941a64f1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/architectures.html @@ -0,0 +1,690 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Architectures +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/architectures + +
    + List all architectures +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/architectures + +
    + List all architectures for operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/architectures/:id + +
    + Show an architecture +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/architectures + +
    + Create an architecture +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + architecture +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + architecture[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Operating system IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/architectures/:id + +
    + Update an architecture +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + architecture +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + architecture[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Operating system IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/architectures/:id + +
    + Delete an architecture +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/architectures/create.html b/foreman/3.16/apidoc/v2/architectures/create.html new file mode 100644 index 00000000..d31c38a1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/architectures/create.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/architectures +
    + Create an architecture +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + architecture +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + architecture[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Operating system IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/architectures/destroy.html b/foreman/3.16/apidoc/v2/architectures/destroy.html new file mode 100644 index 00000000..c2a67fb8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/architectures/destroy.html @@ -0,0 +1,111 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/architectures/:id +
    + Delete an architecture +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/architectures/index.html b/foreman/3.16/apidoc/v2/architectures/index.html new file mode 100644 index 00000000..957f4b2f --- /dev/null +++ b/foreman/3.16/apidoc/v2/architectures/index.html @@ -0,0 +1,257 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/architectures +
    + List all architectures +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/architectures +
    + List all architectures for operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/architectures/show.html b/foreman/3.16/apidoc/v2/architectures/show.html new file mode 100644 index 00000000..dffa6449 --- /dev/null +++ b/foreman/3.16/apidoc/v2/architectures/show.html @@ -0,0 +1,111 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/architectures/:id +
    + Show an architecture +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/architectures/update.html b/foreman/3.16/apidoc/v2/architectures/update.html new file mode 100644 index 00000000..d723c2a8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/architectures/update.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/architectures/:id +
    + Update an architecture +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + architecture +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + architecture[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Operating system IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/audits.html b/foreman/3.16/apidoc/v2/audits.html new file mode 100644 index 00000000..0c83fea5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/audits.html @@ -0,0 +1,577 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Audits +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/audits + +
    + List all audits +

    +

    + + GET /api/hosts/:host_id/audits + +
    + List all audits for a given host +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/audits?search=host%3Dhost12.example25.com&per_page=3
+401
+{
+  "error": {
+    "message": "Unable to authenticate user "
+  }
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    actionstring
    auditable_idinteger
    authored_by_userstring
    authored_by_user.idinteger
    changestext
    commentstring
    hoststring
    hostgroupstring
    hostgroup_titlestring
    idinteger
    interface_fqdnstring
    interface_ipstring
    interface_macstring
    locationstring
    location_idinteger
    organizationstring
    organization_idinteger
    osstring
    os_titlestring
    parameterstring
    partition_tablestring
    provisioning_templatestring
    puppetclass
    remote_addressstring
    request_uuidstring
    settingstring
    timedatetime
    typesetting, user, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, smart_class_parameter, subnet, provisioning_template
    userstring
    usernamestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/audits/:id + +
    + Show an audit +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/audits/index.html b/foreman/3.16/apidoc/v2/audits/index.html new file mode 100644 index 00000000..600bb36e --- /dev/null +++ b/foreman/3.16/apidoc/v2/audits/index.html @@ -0,0 +1,431 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/audits +
    + List all audits +

    +
    +
    +

    + GET /api/hosts/:host_id/audits +
    + List all audits for a given host +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/audits?search=host%3Dhost12.example25.com&per_page=3
+401
+{
+  "error": {
+    "message": "Unable to authenticate user "
+  }
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    actionstring
    auditable_idinteger
    authored_by_userstring
    authored_by_user.idinteger
    changestext
    commentstring
    hoststring
    hostgroupstring
    hostgroup_titlestring
    idinteger
    interface_fqdnstring
    interface_ipstring
    interface_macstring
    locationstring
    location_idinteger
    organizationstring
    organization_idinteger
    osstring
    os_titlestring
    parameterstring
    partition_tablestring
    provisioning_templatestring
    puppetclass
    remote_addressstring
    request_uuidstring
    settingstring
    timedatetime
    typesetting, user, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, smart_class_parameter, subnet, provisioning_template
    userstring
    usernamestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/audits/show.html b/foreman/3.16/apidoc/v2/audits/show.html new file mode 100644 index 00000000..6c7a9e3c --- /dev/null +++ b/foreman/3.16/apidoc/v2/audits/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/audits/:id +
    + Show an audit +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_externals.html b/foreman/3.16/apidoc/v2/auth_source_externals.html new file mode 100644 index 00000000..d70ed74d --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_externals.html @@ -0,0 +1,690 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Auth_source_externals + +
      • + +
    + +
    +

    + Auth_source_externals +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/auth_source_externals + +
    + List external authentication sources +

    +

    + + GET /api/locations/:location_id/auth_source_externals + +
    + List external authentication sources per location +

    +

    + + GET /api/organizations/:organization_id/auth_source_externals + +
    + List external authentication sources per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/auth_source_externals/:id + +
    + Show an external authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/auth_source_externals/:id + +
    + Update an external authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + auth_source_external +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + auth_source_external[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_external[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + auth_source_external[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_externals/index.html b/foreman/3.16/apidoc/v2/auth_source_externals/index.html new file mode 100644 index 00000000..d4800410 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_externals/index.html @@ -0,0 +1,310 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_source_externals +
    + List external authentication sources +

    +
    +
    +

    + GET /api/locations/:location_id/auth_source_externals +
    + List external authentication sources per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/auth_source_externals +
    + List external authentication sources per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_externals/show.html b/foreman/3.16/apidoc/v2/auth_source_externals/show.html new file mode 100644 index 00000000..640efa7f --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_externals/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_source_externals/:id +
    + Show an external authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_externals/update.html b/foreman/3.16/apidoc/v2/auth_source_externals/update.html new file mode 100644 index 00000000..4733c8f6 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_externals/update.html @@ -0,0 +1,273 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/auth_source_externals/:id +
    + Update an external authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + auth_source_external +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + auth_source_external[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_external[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + auth_source_external[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_internals.html b/foreman/3.16/apidoc/v2/auth_source_internals.html new file mode 100644 index 00000000..140372e2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_internals.html @@ -0,0 +1,439 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Auth_source_internals + +
      • + +
    + +
    +

    + Auth_source_internals +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/auth_source_internals + +
    + List internal authentication sources +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/auth_source_internals/:id + +
    + Show an internal authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_internals/index.html b/foreman/3.16/apidoc/v2/auth_source_internals/index.html new file mode 100644 index 00000000..00cdb6ae --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_internals/index.html @@ -0,0 +1,296 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_source_internals +
    + List internal authentication sources +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_internals/show.html b/foreman/3.16/apidoc/v2/auth_source_internals/show.html new file mode 100644 index 00000000..0f7f7c2b --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_internals/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_source_internals/:id +
    + Show an internal authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps.html b/foreman/3.16/apidoc/v2/auth_source_ldaps.html new file mode 100644 index 00000000..f2323030 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps.html @@ -0,0 +1,2131 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Auth_source_ldaps + +
      • + +
    + +
    +

    + Auth_source_ldaps +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/auth_source_ldaps + +
    + List all LDAP authentication sources +

    +

    + + GET /api/locations/:location_id/auth_source_ldaps + +
    + List LDAP authentication sources per location +

    +

    + + GET /api/organizations/:organization_id/auth_source_ldaps + +
    + List LDAP authentication sources per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/auth_source_ldaps/:id + +
    + Show an LDAP authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/auth_source_ldaps + +
    + Create an LDAP authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + auth_source_ldap +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + auth_source_ldap[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[host] +
    + + required + + + +     		+ +

    The hostname of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[port] +
    + + optional + , nil allowed + + +     		+ +

    defaults to 389

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + auth_source_ldap[account] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[base_dn] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[account_password] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_login] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_firstname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_lastname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_mail] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_photo] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[onthefly_register] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[usergroup_sync] +
    + + optional + , nil allowed + + +     		+ +

    sync external user groups on login

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[tls] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[groups_base] +
    + + optional + , nil allowed + + +     		+ +

    groups base DN

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[use_netgroups] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa. Deprecated in favor of ldap_group_membership = nis_netgroups

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[ldap_group_membership] +
    + + optional + , nil allowed + + +     		+ +

    type of group membership to use, applicable only when server_type is posix, free_ipa or netiq. Option rfc4519 is only applicable when server_type is posix.

    + +

    Validations:

    +
      +
    • +

      Must be one of: posix, rfc4519, nis_netgroups.

      +
      • +
    + + + +
    + auth_source_ldap[server_type] +
    + + optional + , nil allowed + + +     		+ +

    type of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be one of: free_ipa, active_directory, posix, netiq.

      +
      • +
    + + + +
    + auth_source_ldap[ldap_filter] +
    + + optional + , nil allowed + + +     		+ +

    LDAP filter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + auth_source_ldap[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/auth_source_ldaps/:id + +
    + Update an LDAP authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + auth_source_ldap[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[host] +
    + + optional + + + +     		+ +

    The hostname of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[port] +
    + + optional + , nil allowed + + +     		+ +

    defaults to 389

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + auth_source_ldap[account] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[base_dn] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[account_password] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_login] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_firstname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_lastname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_mail] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_photo] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[onthefly_register] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[usergroup_sync] +
    + + optional + , nil allowed + + +     		+ +

    sync external user groups on login

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[tls] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[groups_base] +
    + + optional + , nil allowed + + +     		+ +

    groups base DN

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[use_netgroups] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa. Deprecated in favor of ldap_group_membership = nis_netgroups

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[ldap_group_membership] +
    + + optional + , nil allowed + + +     		+ +

    type of group membership to use, applicable only when server_type is posix, free_ipa or netiq. Option rfc4519 is only applicable when server_type is posix.

    + +

    Validations:

    +
      +
    • +

      Must be one of: posix, rfc4519, nis_netgroups.

      +
      • +
    + + + +
    + auth_source_ldap[server_type] +
    + + optional + , nil allowed + + +     		+ +

    type of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be one of: free_ipa, active_directory, posix, netiq.

      +
      • +
    + + + +
    + auth_source_ldap[ldap_filter] +
    + + optional + , nil allowed + + +     		+ +

    LDAP filter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + auth_source_ldap[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/auth_source_ldaps/:id/test + +
    + Test LDAP connection +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/auth_source_ldaps/:id + +
    + Delete an LDAP authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps/create.html b/foreman/3.16/apidoc/v2/auth_source_ldaps/create.html new file mode 100644 index 00000000..3f228d85 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps/create.html @@ -0,0 +1,742 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/auth_source_ldaps +
    + Create an LDAP authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + auth_source_ldap +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + auth_source_ldap[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[host] +
    + + required + + + +     		+ +

    The hostname of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[port] +
    + + optional + , nil allowed + + +     		+ +

    defaults to 389

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + auth_source_ldap[account] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[base_dn] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[account_password] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_login] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_firstname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_lastname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_mail] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_photo] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[onthefly_register] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[usergroup_sync] +
    + + optional + , nil allowed + + +     		+ +

    sync external user groups on login

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[tls] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[groups_base] +
    + + optional + , nil allowed + + +     		+ +

    groups base DN

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[use_netgroups] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa. Deprecated in favor of ldap_group_membership = nis_netgroups

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[ldap_group_membership] +
    + + optional + , nil allowed + + +     		+ +

    type of group membership to use, applicable only when server_type is posix, free_ipa or netiq. Option rfc4519 is only applicable when server_type is posix.

    + +

    Validations:

    +
      +
    • +

      Must be one of: posix, rfc4519, nis_netgroups.

      +
      • +
    + + + +
    + auth_source_ldap[server_type] +
    + + optional + , nil allowed + + +     		+ +

    type of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be one of: free_ipa, active_directory, posix, netiq.

      +
      • +
    + + + +
    + auth_source_ldap[ldap_filter] +
    + + optional + , nil allowed + + +     		+ +

    LDAP filter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + auth_source_ldap[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps/destroy.html b/foreman/3.16/apidoc/v2/auth_source_ldaps/destroy.html new file mode 100644 index 00000000..290c1668 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/auth_source_ldaps/:id +
    + Delete an LDAP authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps/index.html b/foreman/3.16/apidoc/v2/auth_source_ldaps/index.html new file mode 100644 index 00000000..3ad5e6d9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps/index.html @@ -0,0 +1,310 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_source_ldaps +
    + List all LDAP authentication sources +

    +
    +
    +

    + GET /api/locations/:location_id/auth_source_ldaps +
    + List LDAP authentication sources per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/auth_source_ldaps +
    + List LDAP authentication sources per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps/show.html b/foreman/3.16/apidoc/v2/auth_source_ldaps/show.html new file mode 100644 index 00000000..09ee8ba3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_source_ldaps/:id +
    + Show an LDAP authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps/test.html b/foreman/3.16/apidoc/v2/auth_source_ldaps/test.html new file mode 100644 index 00000000..514460de --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps/test.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/auth_source_ldaps/:id/test +
    + Test LDAP connection +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_source_ldaps/update.html b/foreman/3.16/apidoc/v2/auth_source_ldaps/update.html new file mode 100644 index 00000000..1700a1de --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_source_ldaps/update.html @@ -0,0 +1,768 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/auth_source_ldaps/:id +
    + Update an LDAP authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + auth_source_ldap[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[host] +
    + + optional + + + +     		+ +

    The hostname of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[port] +
    + + optional + , nil allowed + + +     		+ +

    defaults to 389

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + auth_source_ldap[account] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[base_dn] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[account_password] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_login] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_firstname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_lastname] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_mail] +
    + + optional + , nil allowed + + +     		+ +

    required if onthefly_register is true

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[attr_photo] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[onthefly_register] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[usergroup_sync] +
    + + optional + , nil allowed + + +     		+ +

    sync external user groups on login

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[tls] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[groups_base] +
    + + optional + , nil allowed + + +     		+ +

    groups base DN

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[use_netgroups] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa. Deprecated in favor of ldap_group_membership = nis_netgroups

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + auth_source_ldap[ldap_group_membership] +
    + + optional + , nil allowed + + +     		+ +

    type of group membership to use, applicable only when server_type is posix, free_ipa or netiq. Option rfc4519 is only applicable when server_type is posix.

    + +

    Validations:

    +
      +
    • +

      Must be one of: posix, rfc4519, nis_netgroups.

      +
      • +
    + + + +
    + auth_source_ldap[server_type] +
    + + optional + , nil allowed + + +     		+ +

    type of the LDAP server

    + +

    Validations:

    +
      +
    • +

      Must be one of: free_ipa, active_directory, posix, netiq.

      +
      • +
    + + + +
    + auth_source_ldap[ldap_filter] +
    + + optional + , nil allowed + + +     		+ +

    LDAP filter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + auth_source_ldap[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + auth_source_ldap[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_sources.html b/foreman/3.16/apidoc/v2/auth_sources.html new file mode 100644 index 00000000..bbe48b80 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_sources.html @@ -0,0 +1,336 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Auth_sources +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/auth_sources + +
    + List all authentication sources +

    +

    + + GET /api/locations/:location_id/auth_sources + +
    + List all authentication sources per location +

    +

    + + GET /api/organizations/:organization_id/auth_sources + +
    + List all authentication sources per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/auth_sources/index.html b/foreman/3.16/apidoc/v2/auth_sources/index.html new file mode 100644 index 00000000..7a278068 --- /dev/null +++ b/foreman/3.16/apidoc/v2/auth_sources/index.html @@ -0,0 +1,310 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/auth_sources +
    + List all authentication sources +

    +
    +
    +

    + GET /api/locations/:location_id/auth_sources +
    + List all authentication sources per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/auth_sources +
    + List all authentication sources per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/autosign.html b/foreman/3.16/apidoc/v2/autosign.html new file mode 100644 index 00000000..30a9daf6 --- /dev/null +++ b/foreman/3.16/apidoc/v2/autosign.html @@ -0,0 +1,409 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Autosign +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/smart_proxies/:smart_proxy_id/autosign + +
    + List all autosign entries +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Autosign entry name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Autosign entry name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/autosign/create.html b/foreman/3.16/apidoc/v2/autosign/create.html new file mode 100644 index 00000000..0ad30138 --- /dev/null +++ b/foreman/3.16/apidoc/v2/autosign/create.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/smart_proxies/:smart_proxy_id/autosign +
    + Create autosign entry +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Autosign entry name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/autosign/destroy.html b/foreman/3.16/apidoc/v2/autosign/destroy.html new file mode 100644 index 00000000..f7dae47d --- /dev/null +++ b/foreman/3.16/apidoc/v2/autosign/destroy.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/smart_proxies/:smart_proxy_id/autosign/:id +
    + Delete autosign entry +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Autosign entry name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/autosign/index.html b/foreman/3.16/apidoc/v2/autosign/index.html new file mode 100644 index 00000000..757e8485 --- /dev/null +++ b/foreman/3.16/apidoc/v2/autosign/index.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/smart_proxies/:smart_proxy_id/autosign +
    + List all autosign entries +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/bookmarks.html b/foreman/3.16/apidoc/v2/bookmarks.html new file mode 100644 index 00000000..be358bfa --- /dev/null +++ b/foreman/3.16/apidoc/v2/bookmarks.html @@ -0,0 +1,1061 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Bookmarks +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/bookmarks + +
    + List all bookmarks +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/v2/bookmarks?page=1&per_page=10&search=
+200
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 10,
+  "search": "",
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "name": "foo",
+      "controller": "hosts",
+      "query": "foo=boo",
+      "public": true,
+      "id": 980190962,
+      "owner_id": null,
+      "owner_type": null
+    },
+    {
+      "name": "three",
+      "controller": "hosts",
+      "query": "three",
+      "public": true,
+      "id": 113629430,
+      "owner_id": null,
+      "owner_type": null
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    controllerstring
    idinteger
    namestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/bookmarks/:id + +
    + Show a bookmark +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/bookmarks + +
    + Create a bookmark +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + bookmark +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + bookmark[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[controller] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[query] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[public] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/bookmarks/:id + +
    + Update a bookmark +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + bookmark +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + bookmark[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[controller] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[query] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[public] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/bookmarks/:id + +
    + Delete a bookmark +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/bookmarks/create.html b/foreman/3.16/apidoc/v2/bookmarks/create.html new file mode 100644 index 00000000..de120592 --- /dev/null +++ b/foreman/3.16/apidoc/v2/bookmarks/create.html @@ -0,0 +1,269 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/bookmarks +
    + Create a bookmark +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + bookmark +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + bookmark[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[controller] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[query] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[public] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/bookmarks/destroy.html b/foreman/3.16/apidoc/v2/bookmarks/destroy.html new file mode 100644 index 00000000..d0ff8d57 --- /dev/null +++ b/foreman/3.16/apidoc/v2/bookmarks/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/bookmarks/:id +
    + Delete a bookmark +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/bookmarks/index.html b/foreman/3.16/apidoc/v2/bookmarks/index.html new file mode 100644 index 00000000..a3f6821c --- /dev/null +++ b/foreman/3.16/apidoc/v2/bookmarks/index.html @@ -0,0 +1,315 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/bookmarks +
    + List all bookmarks +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/v2/bookmarks?page=1&per_page=10&search=
+200
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 10,
+  "search": "",
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "name": "foo",
+      "controller": "hosts",
+      "query": "foo=boo",
+      "public": true,
+      "id": 980190962,
+      "owner_id": null,
+      "owner_type": null
+    },
+    {
+      "name": "three",
+      "controller": "hosts",
+      "query": "three",
+      "public": true,
+      "id": 113629430,
+      "owner_id": null,
+      "owner_type": null
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    controllerstring
    idinteger
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/bookmarks/show.html b/foreman/3.16/apidoc/v2/bookmarks/show.html new file mode 100644 index 00000000..7b2aaf4e --- /dev/null +++ b/foreman/3.16/apidoc/v2/bookmarks/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/bookmarks/:id +
    + Show a bookmark +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/bookmarks/update.html b/foreman/3.16/apidoc/v2/bookmarks/update.html new file mode 100644 index 00000000..79358d65 --- /dev/null +++ b/foreman/3.16/apidoc/v2/bookmarks/update.html @@ -0,0 +1,295 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/bookmarks/:id +
    + Update a bookmark +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + bookmark +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + bookmark[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[controller] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[query] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + bookmark[public] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/common_parameters.html b/foreman/3.16/apidoc/v2/common_parameters.html new file mode 100644 index 00000000..05e9e026 --- /dev/null +++ b/foreman/3.16/apidoc/v2/common_parameters.html @@ -0,0 +1,1137 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Common_parameters + +
      • + +
    + +
    +

    + Common_parameters +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/common_parameters + +
    + List all global parameters +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    domain_namestring
    host_group_namestring
    host_namestring
    idinteger
    key_typestring
    location_namestring
    namestring
    organization_namestring
    os_namestring
    parameter_typestring
    subnet_nametext
    typestring
    valuetext
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/common_parameters/:id + +
    + Show a global parameter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/common_parameters + +
    + Create a global parameter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + common_parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + common_parameter[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[value] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[parameter_type] +
    + + required + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + common_parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/common_parameters/:id + +
    + Update a global parameter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + common_parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + common_parameter[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[value] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[parameter_type] +
    + + optional + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + common_parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/common_parameters/:id + +
    + Delete a global parameter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/common_parameters/create.html b/foreman/3.16/apidoc/v2/common_parameters/create.html new file mode 100644 index 00000000..75e79136 --- /dev/null +++ b/foreman/3.16/apidoc/v2/common_parameters/create.html @@ -0,0 +1,271 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/common_parameters +
    + Create a global parameter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + common_parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + common_parameter[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[value] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[parameter_type] +
    + + required + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + common_parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/common_parameters/destroy.html b/foreman/3.16/apidoc/v2/common_parameters/destroy.html new file mode 100644 index 00000000..1ba959a1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/common_parameters/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/common_parameters/:id +
    + Delete a global parameter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/common_parameters/index.html b/foreman/3.16/apidoc/v2/common_parameters/index.html new file mode 100644 index 00000000..2e4be3f0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/common_parameters/index.html @@ -0,0 +1,359 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/common_parameters +
    + List all global parameters +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    domain_namestring
    host_group_namestring
    host_namestring
    idinteger
    key_typestring
    location_namestring
    namestring
    organization_namestring
    os_namestring
    parameter_typestring
    subnet_nametext
    typestring
    valuetext
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/common_parameters/show.html b/foreman/3.16/apidoc/v2/common_parameters/show.html new file mode 100644 index 00000000..a4866684 --- /dev/null +++ b/foreman/3.16/apidoc/v2/common_parameters/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/common_parameters/:id +
    + Show a global parameter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/common_parameters/update.html b/foreman/3.16/apidoc/v2/common_parameters/update.html new file mode 100644 index 00000000..4a8f27a5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/common_parameters/update.html @@ -0,0 +1,297 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/common_parameters/:id +
    + Update a global parameter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + common_parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + common_parameter[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[value] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + common_parameter[parameter_type] +
    + + optional + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + common_parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_attributes.html b/foreman/3.16/apidoc/v2/compute_attributes.html new file mode 100644 index 00000000..b187084e --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_attributes.html @@ -0,0 +1,1047 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Compute_attributes + +
      • + +
    + +
    +

    + Compute_attributes +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes + +
    + List of compute attributes for provided compute profile and compute resource +

    +

    + + GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes + +
    + List of compute attributes for provided compute profile and compute resource +

    +

    + + GET /api/compute_resources/:compute_resource_id/compute_attributes + +
    + List of compute attributes for compute resource +

    +

    + + GET /api/compute_profiles/:compute_profile_id/compute_attributes + +
    + List of compute attributes for compute profile +

    +

    + + GET /api/compute_attributes/:id + +
    + List of compute attributes +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile_id +
    + + optional + + + +     		+ +

    ID of compute profile

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    ID of compute_resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    compute_profilestring
    compute_resourcestring
    idinteger
    namestring
    + + + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_attribute +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_attribute[vm_attrs] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_attribute +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_attribute[vm_attrs] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_attributes/create.html b/foreman/3.16/apidoc/v2/compute_attributes/create.html new file mode 100644 index 00000000..3a272de7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_attributes/create.html @@ -0,0 +1,271 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes +
    + Create a compute attributes set +

    +
    +
    +

    + POST /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes +
    + Create a compute attributes set +

    +
    +
    +

    + POST /api/compute_resources/:compute_resource_id/compute_attributes +
    + Create a compute attributes set +

    +
    +
    +

    + POST /api/compute_profiles/:compute_profile_id/compute_attributes +
    + Create a compute attributes set +

    +
    +
    +

    + POST /api/compute_attributes +
    + Create a compute attributes set +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_attribute +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_attribute[vm_attrs] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_attributes/index.html b/foreman/3.16/apidoc/v2/compute_attributes/index.html new file mode 100644 index 00000000..1d51a3e7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_attributes/index.html @@ -0,0 +1,370 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes +
    + List of compute attributes for provided compute profile and compute resource +

    +
    +
    +

    + GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes +
    + List of compute attributes for provided compute profile and compute resource +

    +
    +
    +

    + GET /api/compute_resources/:compute_resource_id/compute_attributes +
    + List of compute attributes for compute resource +

    +
    +
    +

    + GET /api/compute_profiles/:compute_profile_id/compute_attributes +
    + List of compute attributes for compute profile +

    +
    +
    +

    + GET /api/compute_attributes/:id +
    + List of compute attributes +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile_id +
    + + optional + + + +     		+ +

    ID of compute profile

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    ID of compute_resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    compute_profilestring
    compute_resourcestring
    idinteger
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_attributes/show.html b/foreman/3.16/apidoc/v2/compute_attributes/show.html new file mode 100644 index 00000000..8f97a942 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_attributes/show.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id +
    + Show a compute attributes set +

    +
    +
    +

    + GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id +
    + Show a compute attributes set +

    +
    +
    +

    + GET /api/compute_resources/:compute_resource_id/compute_attributes/:id +
    + Show a compute attributes set +

    +
    +
    +

    + GET /api/compute_profiles/:compute_profile_id/compute_attributes/:id +
    + Show a compute attributes set +

    +
    +
    +

    + GET /api/compute_attributes/:id +
    + Show a compute attributes set +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_attributes/update.html b/foreman/3.16/apidoc/v2/compute_attributes/update.html new file mode 100644 index 00000000..f641d84f --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_attributes/update.html @@ -0,0 +1,297 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id +
    + Update a compute attributes set +

    +
    +
    +

    + PUT /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id +
    + Update a compute attributes set +

    +
    +
    +

    + PUT /api/compute_resources/:compute_resource_id/compute_attributes/:id +
    + Update a compute attributes set +

    +
    +
    +

    + PUT /api/compute_profiles/:compute_profile_id/compute_attributes/:id +
    + Update a compute attributes set +

    +
    +
    +

    + PUT /api/compute_attributes/:id +
    + Update a compute attributes set +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_attribute +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_attribute[vm_attrs] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_profiles.html b/foreman/3.16/apidoc/v2/compute_profiles.html new file mode 100644 index 00000000..6935c5ba --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_profiles.html @@ -0,0 +1,866 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Compute_profiles + +
      • + +
    + +
    +

    + Compute_profiles +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/compute_profiles + +
    + List of compute profiles +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_profiles/:id + +
    + Show a compute profile +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/compute_profiles + +
    + Create a compute profile +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_profile[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/compute_profiles/:id + +
    + Update a compute profile +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_profile +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_profile[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/compute_profiles/:id + +
    + Delete a compute profile +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_profiles/create.html b/foreman/3.16/apidoc/v2/compute_profiles/create.html new file mode 100644 index 00000000..5e02572c --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_profiles/create.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/compute_profiles +
    + Create a compute profile +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_profile +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_profile[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_profiles/destroy.html b/foreman/3.16/apidoc/v2/compute_profiles/destroy.html new file mode 100644 index 00000000..1d2259e9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_profiles/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/compute_profiles/:id +
    + Delete a compute profile +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_profiles/index.html b/foreman/3.16/apidoc/v2/compute_profiles/index.html new file mode 100644 index 00000000..92ecd3f3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_profiles/index.html @@ -0,0 +1,276 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_profiles +
    + List of compute profiles +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_profiles/show.html b/foreman/3.16/apidoc/v2/compute_profiles/show.html new file mode 100644 index 00000000..7462cb92 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_profiles/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_profiles/:id +
    + Show a compute profile +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_profiles/update.html b/foreman/3.16/apidoc/v2/compute_profiles/update.html new file mode 100644 index 00000000..8ff4f1ee --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_profiles/update.html @@ -0,0 +1,217 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_profiles/:id +
    + Update a compute profile +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_profile +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_profile[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources.html b/foreman/3.16/apidoc/v2/compute_resources.html new file mode 100644 index 00000000..4d4599bd --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources.html @@ -0,0 +1,4419 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Compute_resources + +
      • + +
    + +
    +

    + Compute_resources +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources + +
    + List all compute resources +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    typestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id + +
    + Show a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/compute_resources + +
    + Create a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_resource[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[provider] +
    + + optional + , nil allowed + + +     		+ +

    Providers include Libvirt, EC2, Vmware, Openstack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[url] +
    + + optional + , nil allowed + + +     		+ +

    URL for Libvirt and OpenStack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[user] +
    + + optional + , nil allowed + + +     		+ +

    Username for EC2, VMware, OpenStack. Access Key for EC2.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[password] +
    + + optional + , nil allowed + + +     		+ +

    Password for EC2, VMware, OpenStack. Secret key for EC2

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[datacenter] +
    + + optional + , nil allowed + + +     		+ +

    for VMware Datacenter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[region] +
    + + optional + , nil allowed + + +     		+ +

    for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[tenant] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack and AzureRm only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[domain] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_name] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_id] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[server] +
    + + optional + , nil allowed + + +     		+ +

    for VMware

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[set_console_password] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt and VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[display_type] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt only

    + +

    Validations:

    +
      +
    • +

      Must be one of: VNC, SPICE.

      +
      • +
    + + + +
    + compute_resource[caching_enabled] +
    + + optional + , nil allowed + + +     		+ +

    enable caching, for VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + compute_resource[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/compute_resources/:id + +
    + Update a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_resource[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[provider] +
    + + optional + , nil allowed + + +     		+ +

    Providers include Libvirt, EC2, Vmware, Openstack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[url] +
    + + optional + , nil allowed + + +     		+ +

    URL for Libvirt and OpenStack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[user] +
    + + optional + , nil allowed + + +     		+ +

    Username for EC2, VMware, OpenStack. Access Key for EC2.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[password] +
    + + optional + , nil allowed + + +     		+ +

    Password for EC2, VMware, OpenStack. Secret key for EC2

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[datacenter] +
    + + optional + , nil allowed + + +     		+ +

    for VMware Datacenter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[region] +
    + + optional + , nil allowed + + +     		+ +

    for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[tenant] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack and AzureRm only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[domain] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_name] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_id] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[server] +
    + + optional + , nil allowed + + +     		+ +

    for VMware

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[set_console_password] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt and VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[display_type] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt only

    + +

    Validations:

    +
      +
    • +

      Must be one of: VNC, SPICE.

      +
      • +
    + + + +
    + compute_resource[caching_enabled] +
    + + optional + , nil allowed + + +     		+ +

    enable caching, for VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + compute_resource[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/compute_resources/:id + +
    + Delete a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_images + +
    + List available images for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_clusters + +
    + List available clusters for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_flavors + +
    + List available flavors for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_folders + +
    + List available folders for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_zones + +
    + List available zone for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_networks + +
    + List available networks for a compute resource +

    +

    + + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks + +
    + List available networks for a compute resource cluster +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools + +
    + List resource pools for a compute resource cluster +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/storage_domains/:storage_domain_id + +
    + List attributes for a given storage domain +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + storage_domain_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_storage_domains + +
    + List storage domains for a compute resource +

    +

    + + GET /api/compute_resources/:id/available_storage_domains/:storage_domain + + DEPRECATED +
    + List attributes for a given storage domain +

    +

    + + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains + +
    + List storage domains for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + storage_domain + DEPRECATED +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/storage_pods/:storage_pod_id + +
    + List attributes for a given storage pod +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + storage_pod_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_storage_pods + +
    + List storage pods for a compute resource +

    +

    + + GET /api/compute_resources/:id/available_storage_pods/:storage_pod + + DEPRECATED +
    + List attributes for a given storage pod +

    +

    + + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods + +
    + List storage pods for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + storage_pod + DEPRECATED +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_security_groups + +
    + List available security groups for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/compute_resources/:id/refresh_cache + +
    + Refresh Compute Resource Cache +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:id/available_virtual_machines + +
    + List available virtual machines for a compute resource +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/associate.html b/foreman/3.16/apidoc/v2/compute_resources/associate.html new file mode 100644 index 00000000..9059dbf0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/associate.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_resources/:id/associate/:vm_id +
    + Associate VMs to Hosts +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_clusters.html b/foreman/3.16/apidoc/v2/compute_resources/available_clusters.html new file mode 100644 index 00000000..bdd361dc --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_clusters.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_clusters +
    + List available clusters for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_flavors.html b/foreman/3.16/apidoc/v2/compute_resources/available_flavors.html new file mode 100644 index 00000000..18ed27ab --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_flavors.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_flavors +
    + List available flavors for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_folders.html b/foreman/3.16/apidoc/v2/compute_resources/available_folders.html new file mode 100644 index 00000000..bbb0f3e9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_folders.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_folders +
    + List available folders for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_images.html b/foreman/3.16/apidoc/v2/compute_resources/available_images.html new file mode 100644 index 00000000..a9734b01 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_images.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_images +
    + List available images for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_networks.html b/foreman/3.16/apidoc/v2/compute_resources/available_networks.html new file mode 100644 index 00000000..7a05c0af --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_networks.html @@ -0,0 +1,198 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_networks +
    + List available networks for a compute resource +

    +
    +
    +

    + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks +
    + List available networks for a compute resource cluster +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_resource_pools.html b/foreman/3.16/apidoc/v2/compute_resources/available_resource_pools.html new file mode 100644 index 00000000..92a91c51 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_resource_pools.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools +
    + List resource pools for a compute resource cluster +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_security_groups.html b/foreman/3.16/apidoc/v2/compute_resources/available_security_groups.html new file mode 100644 index 00000000..b44cb64c --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_security_groups.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_security_groups +
    + List available security groups for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_storage_domains.html b/foreman/3.16/apidoc/v2/compute_resources/available_storage_domains.html new file mode 100644 index 00000000..1cf3dcd1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_storage_domains.html @@ -0,0 +1,233 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_storage_domains +
    + List storage domains for a compute resource +

    +
    +
    +

    + GET /api/compute_resources/:id/available_storage_domains/:storage_domain + DEPRECATED +
    + List attributes for a given storage domain +

    +
    +
    +

    + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains +
    + List storage domains for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + storage_domain + DEPRECATED +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_storage_pods.html b/foreman/3.16/apidoc/v2/compute_resources/available_storage_pods.html new file mode 100644 index 00000000..7c084d3b --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_storage_pods.html @@ -0,0 +1,233 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_storage_pods +
    + List storage pods for a compute resource +

    +
    +
    +

    + GET /api/compute_resources/:id/available_storage_pods/:storage_pod + DEPRECATED +
    + List attributes for a given storage pod +

    +
    +
    +

    + GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods +
    + List storage pods for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + cluster_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + storage_pod + DEPRECATED +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_virtual_machines.html b/foreman/3.16/apidoc/v2/compute_resources/available_virtual_machines.html new file mode 100644 index 00000000..d37248e5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_virtual_machines.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_virtual_machines +
    + List available virtual machines for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/available_zones.html b/foreman/3.16/apidoc/v2/compute_resources/available_zones.html new file mode 100644 index 00000000..ef228ca3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/available_zones.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_zones +
    + List available zone for a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/create.html b/foreman/3.16/apidoc/v2/compute_resources/create.html new file mode 100644 index 00000000..d1789a7a --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/create.html @@ -0,0 +1,665 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/compute_resources +
    + Create a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_resource[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[provider] +
    + + optional + , nil allowed + + +     		+ +

    Providers include Libvirt, EC2, Vmware, Openstack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[url] +
    + + optional + , nil allowed + + +     		+ +

    URL for Libvirt and OpenStack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[user] +
    + + optional + , nil allowed + + +     		+ +

    Username for EC2, VMware, OpenStack. Access Key for EC2.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[password] +
    + + optional + , nil allowed + + +     		+ +

    Password for EC2, VMware, OpenStack. Secret key for EC2

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[datacenter] +
    + + optional + , nil allowed + + +     		+ +

    for VMware Datacenter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[region] +
    + + optional + , nil allowed + + +     		+ +

    for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[tenant] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack and AzureRm only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[domain] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_name] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_id] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[server] +
    + + optional + , nil allowed + + +     		+ +

    for VMware

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[set_console_password] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt and VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[display_type] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt only

    + +

    Validations:

    +
      +
    • +

      Must be one of: VNC, SPICE.

      +
      • +
    + + + +
    + compute_resource[caching_enabled] +
    + + optional + , nil allowed + + +     		+ +

    enable caching, for VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + compute_resource[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/destroy.html b/foreman/3.16/apidoc/v2/compute_resources/destroy.html new file mode 100644 index 00000000..556a3af5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/compute_resources/:id +
    + Delete a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/destroy_vm.html b/foreman/3.16/apidoc/v2/compute_resources/destroy_vm.html new file mode 100644 index 00000000..54819189 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/destroy_vm.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/compute_resources/:id/available_virtual_machines/:vm_id +
    + Delete a Virtual Machine +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/index.html b/foreman/3.16/apidoc/v2/compute_resources/index.html new file mode 100644 index 00000000..f3a107d2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/index.html @@ -0,0 +1,301 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources +
    + List all compute resources +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    typestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/power_vm.html b/foreman/3.16/apidoc/v2/compute_resources/power_vm.html new file mode 100644 index 00000000..7e21d856 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/power_vm.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_resources/:id/available_virtual_machines/:vm_id/power +
    + Power a Virtual Machine +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/refresh_cache.html b/foreman/3.16/apidoc/v2/compute_resources/refresh_cache.html new file mode 100644 index 00000000..74ba5890 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/refresh_cache.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_resources/:id/refresh_cache +
    + Refresh Compute Resource Cache +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/show.html b/foreman/3.16/apidoc/v2/compute_resources/show.html new file mode 100644 index 00000000..ae82274a --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id +
    + Show a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/show_vm.html b/foreman/3.16/apidoc/v2/compute_resources/show_vm.html new file mode 100644 index 00000000..06176b0e --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/show_vm.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/available_virtual_machines/:vm_id +
    + Show a virtual machine +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + vm_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/storage_domain.html b/foreman/3.16/apidoc/v2/compute_resources/storage_domain.html new file mode 100644 index 00000000..972ef66f --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/storage_domain.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/storage_domains/:storage_domain_id +
    + List attributes for a given storage domain +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + storage_domain_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/storage_pod.html b/foreman/3.16/apidoc/v2/compute_resources/storage_pod.html new file mode 100644 index 00000000..3152cfb9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/storage_pod.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:id/storage_pods/:storage_pod_id +
    + List attributes for a given storage pod +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + storage_pod_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/compute_resources/update.html b/foreman/3.16/apidoc/v2/compute_resources/update.html new file mode 100644 index 00000000..4a9a23d7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/compute_resources/update.html @@ -0,0 +1,691 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_resources/:id +
    + Update a compute resource +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + compute_resource[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[provider] +
    + + optional + , nil allowed + + +     		+ +

    Providers include Libvirt, EC2, Vmware, Openstack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[url] +
    + + optional + , nil allowed + + +     		+ +

    URL for Libvirt and OpenStack

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[user] +
    + + optional + , nil allowed + + +     		+ +

    Username for EC2, VMware, OpenStack. Access Key for EC2.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[password] +
    + + optional + , nil allowed + + +     		+ +

    Password for EC2, VMware, OpenStack. Secret key for EC2

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[datacenter] +
    + + optional + , nil allowed + + +     		+ +

    for VMware Datacenter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[region] +
    + + optional + , nil allowed + + +     		+ +

    for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[tenant] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack and AzureRm only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[domain] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_name] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[project_domain_id] +
    + + optional + , nil allowed + + +     		+ +

    for OpenStack (v3) only

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[server] +
    + + optional + , nil allowed + + +     		+ +

    for VMware

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + compute_resource[set_console_password] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt and VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[display_type] +
    + + optional + , nil allowed + + +     		+ +

    for Libvirt only

    + +

    Validations:

    +
      +
    • +

      Must be one of: VNC, SPICE.

      +
      • +
    + + + +
    + compute_resource[caching_enabled] +
    + + optional + , nil allowed + + +     		+ +

    enable caching, for VMware only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + compute_resource[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + compute_resource[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/config_reports.html b/foreman/3.16/apidoc/v2/config_reports.html new file mode 100644 index 00000000..378d7247 --- /dev/null +++ b/foreman/3.16/apidoc/v2/config_reports.html @@ -0,0 +1,1094 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Config_reports +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/config_reports + +
    + List all reports +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    appliedinteger
    eventfultrue, false
    failedinteger
    failed_restartsinteger
    hoststring
    host_idinteger
    host_owner_idinteger
    hostgroupstring
    hostgroup_fullnamestring
    hostgroup_titlestring
    idinteger
    last_reportdatetime
    locationstring
    logtext
    organizationstring
    originstring
    pendinginteger
    reporteddatetime
    resourcetext
    restartedinteger
    skippedinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/config_reports/:id + +
    + Show a report +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/config_reports + +
    + Create a report +

    +
    + + +
    + + + + +

    Examples

    + 
    POST /api/v2/config_reports
+{
+  "config_report": {
+    "host": "report.example.com",
+    "logs": [
+      {
+        "log": {
+          "level": "err",
+          "messages": {
+            "message": "Could not retrieve catalog from remote server: Error 400 on SERVER: Could not find node 'rhel6n01.corp.com'; cannot compile"
+          },
+          "sources": {
+            "source": "Puppet"
+          }
+        }
+      },
+      {
+        "log": {
+          "level": "notice",
+          "messages": {
+            "message": "Using cached catalog"
+          },
+          "sources": {
+            "source": "Puppet"
+          }
+        }
+      },
+      {
+        "log": {
+          "level": "err",
+          "messages": {
+            "message": "Could not retrieve catalog; skipping run"
+          },
+          "sources": {
+            "source": "Puppet"
+          }
+        }
+      }
+    ],
+    "metrics": {},
+    "reported_at": "2010-11-19 02:39:04 UTC",
+    "status": {
+      "applied": 0,
+      "failed": 0,
+      "failed_restarts": 0,
+      "pending": 0,
+      "restarted": 0,
+      "skipped": 0
+    }
+  }
+}
+201
+{
+  "metrics": {},
+  "created_at": "2025-08-20 10:28:29 UTC",
+  "updated_at": "2025-08-20 10:28:29 UTC",
+  "id": 2,
+  "host_id": 2,
+  "host_name": "report.example.com",
+  "reported_at": "2010-11-19 02:39:04 UTC",
+  "status": {
+    "applied": 0,
+    "restarted": 0,
+    "failed": 0,
+    "failed_restarts": 0,
+    "skipped": 0,
+    "pending": 0
+  },
+  "origin": "Puppet"
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + config_report +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + config_report[host] +
    + + required + + + +     		+ +

    Hostname or certname

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + config_report[reported_at] +
    + + required + + + +     		+ +

    UTC time of report

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + config_report[status] +
    + + required + + + +     		+ +

    Hash of status type totals

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + config_report[metrics] +
    + + required + + + +     		+ +

    Hash of report metrics, can be just {}

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + config_report[logs] +
    + + optional + , nil allowed + + +     		+ +

    Optional array of log hashes

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/config_reports/:id + +
    + Delete a report +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:host_id/config_reports/last + +
    + Show the last report for a host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/config_reports/create.html b/foreman/3.16/apidoc/v2/config_reports/create.html new file mode 100644 index 00000000..ac746478 --- /dev/null +++ b/foreman/3.16/apidoc/v2/config_reports/create.html @@ -0,0 +1,376 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/config_reports +
    + Create a report +

    +
    + +
    + + + + + +

    Examples

    + 
    POST /api/v2/config_reports
+{
+  "config_report": {
+    "host": "report.example.com",
+    "logs": [
+      {
+        "log": {
+          "level": "err",
+          "messages": {
+            "message": "Could not retrieve catalog from remote server: Error 400 on SERVER: Could not find node 'rhel6n01.corp.com'; cannot compile"
+          },
+          "sources": {
+            "source": "Puppet"
+          }
+        }
+      },
+      {
+        "log": {
+          "level": "notice",
+          "messages": {
+            "message": "Using cached catalog"
+          },
+          "sources": {
+            "source": "Puppet"
+          }
+        }
+      },
+      {
+        "log": {
+          "level": "err",
+          "messages": {
+            "message": "Could not retrieve catalog; skipping run"
+          },
+          "sources": {
+            "source": "Puppet"
+          }
+        }
+      }
+    ],
+    "metrics": {},
+    "reported_at": "2010-11-19 02:39:04 UTC",
+    "status": {
+      "applied": 0,
+      "failed": 0,
+      "failed_restarts": 0,
+      "pending": 0,
+      "restarted": 0,
+      "skipped": 0
+    }
+  }
+}
+201
+{
+  "metrics": {},
+  "created_at": "2025-08-20 10:28:29 UTC",
+  "updated_at": "2025-08-20 10:28:29 UTC",
+  "id": 2,
+  "host_id": 2,
+  "host_name": "report.example.com",
+  "reported_at": "2010-11-19 02:39:04 UTC",
+  "status": {
+    "applied": 0,
+    "restarted": 0,
+    "failed": 0,
+    "failed_restarts": 0,
+    "skipped": 0,
+    "pending": 0
+  },
+  "origin": "Puppet"
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + config_report +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + config_report[host] +
    + + required + + + +     		+ +

    Hostname or certname

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + config_report[reported_at] +
    + + required + + + +     		+ +

    UTC time of report

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + config_report[status] +
    + + required + + + +     		+ +

    Hash of status type totals

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + config_report[metrics] +
    + + required + + + +     		+ +

    Hash of report metrics, can be just {}

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + config_report[logs] +
    + + optional + , nil allowed + + +     		+ +

    Optional array of log hashes

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/config_reports/destroy.html b/foreman/3.16/apidoc/v2/config_reports/destroy.html new file mode 100644 index 00000000..21674a84 --- /dev/null +++ b/foreman/3.16/apidoc/v2/config_reports/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/config_reports/:id +
    + Delete a report +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/config_reports/index.html b/foreman/3.16/apidoc/v2/config_reports/index.html new file mode 100644 index 00000000..f99b3d1c --- /dev/null +++ b/foreman/3.16/apidoc/v2/config_reports/index.html @@ -0,0 +1,371 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/config_reports +
    + List all reports +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    appliedinteger
    eventfultrue, false
    failedinteger
    failed_restartsinteger
    hoststring
    host_idinteger
    host_owner_idinteger
    hostgroupstring
    hostgroup_fullnamestring
    hostgroup_titlestring
    idinteger
    last_reportdatetime
    locationstring
    logtext
    organizationstring
    originstring
    pendinginteger
    reporteddatetime
    resourcetext
    restartedinteger
    skippedinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/config_reports/last.html b/foreman/3.16/apidoc/v2/config_reports/last.html new file mode 100644 index 00000000..efa1aacd --- /dev/null +++ b/foreman/3.16/apidoc/v2/config_reports/last.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:host_id/config_reports/last +
    + Show the last report for a host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/config_reports/show.html b/foreman/3.16/apidoc/v2/config_reports/show.html new file mode 100644 index 00000000..783f023f --- /dev/null +++ b/foreman/3.16/apidoc/v2/config_reports/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/config_reports/:id +
    + Show a report +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/dashboard.html b/foreman/3.16/apidoc/v2/dashboard.html new file mode 100644 index 00000000..80c14cf4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/dashboard.html @@ -0,0 +1,187 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Dashboard +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/dashboard + +
    + Get dashboard details +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/dashboard/index.html b/foreman/3.16/apidoc/v2/dashboard/index.html new file mode 100644 index 00000000..254876a6 --- /dev/null +++ b/foreman/3.16/apidoc/v2/dashboard/index.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/dashboard +
    + Get dashboard details +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/domains.html b/foreman/3.16/apidoc/v2/domains.html new file mode 100644 index 00000000..9bf7ed72 --- /dev/null +++ b/foreman/3.16/apidoc/v2/domains.html @@ -0,0 +1,1273 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Domains +
    + +

    +
    + +
    +

    Foreman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are of the form hostname.somewhere.com then the domain is somewhere.com. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.

    +
    + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/domains + +
    + List of domains +

    +

    + + GET /api/subnets/:subnet_id/domains + +
    + List of domains per subnet +

    +

    + + GET /api/locations/:location_id/domains + +
    + List of domains per location +

    +

    + + GET /api/organizations/:organization_id/domains + +
    + List of domains per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    fullnamestring
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    paramsstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/domains/:id + +
    + Show a domain +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Numerical ID or domain name

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/domains + +
    + Create a domain +

    +
    + + +
    + +

    The fullname field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + domain +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + domain[name] +
    + + required + + + +     		+ +

    The full DNS domain name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[fullname] +
    + + optional + , nil allowed + + +     		+ +

    Description of the domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS proxy ID to use within this domain

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + domain[domain_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/domains/:id + +
    + Update a domain +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + domain +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + domain[name] +
    + + optional + + + +     		+ +

    The full DNS domain name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[fullname] +
    + + optional + , nil allowed + + +     		+ +

    Description of the domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS proxy ID to use within this domain

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + domain[domain_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/domains/:id + +
    + Delete a domain +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/domains/create.html b/foreman/3.16/apidoc/v2/domains/create.html new file mode 100644 index 00000000..e02af22f --- /dev/null +++ b/foreman/3.16/apidoc/v2/domains/create.html @@ -0,0 +1,335 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/domains +
    + Create a domain +

    +
    + +
    + + +

    The fullname field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + domain +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + domain[name] +
    + + required + + + +     		+ +

    The full DNS domain name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[fullname] +
    + + optional + , nil allowed + + +     		+ +

    Description of the domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS proxy ID to use within this domain

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + domain[domain_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/domains/destroy.html b/foreman/3.16/apidoc/v2/domains/destroy.html new file mode 100644 index 00000000..1defac1e --- /dev/null +++ b/foreman/3.16/apidoc/v2/domains/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/domains/:id +
    + Delete a domain +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/domains/index.html b/foreman/3.16/apidoc/v2/domains/index.html new file mode 100644 index 00000000..cedb3e24 --- /dev/null +++ b/foreman/3.16/apidoc/v2/domains/index.html @@ -0,0 +1,355 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/domains +
    + List of domains +

    +
    +
    +

    + GET /api/subnets/:subnet_id/domains +
    + List of domains per subnet +

    +
    +
    +

    + GET /api/locations/:location_id/domains +
    + List of domains per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/domains +
    + List of domains per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    fullnamestring
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    paramsstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/domains/show.html b/foreman/3.16/apidoc/v2/domains/show.html new file mode 100644 index 00000000..1900beef --- /dev/null +++ b/foreman/3.16/apidoc/v2/domains/show.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/domains/:id +
    + Show a domain +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Numerical ID or domain name

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/domains/update.html b/foreman/3.16/apidoc/v2/domains/update.html new file mode 100644 index 00000000..371d2f23 --- /dev/null +++ b/foreman/3.16/apidoc/v2/domains/update.html @@ -0,0 +1,359 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/domains/:id +
    + Update a domain +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + domain +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + domain[name] +
    + + optional + + + +     		+ +

    The full DNS domain name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[fullname] +
    + + optional + , nil allowed + + +     		+ +

    Description of the domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS proxy ID to use within this domain

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + domain[domain_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + domain[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups.html b/foreman/3.16/apidoc/v2/external_usergroups.html new file mode 100644 index 00000000..46a953ee --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups.html @@ -0,0 +1,788 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + External_usergroups + +
      • + +
    + +
    +

    + External_usergroups +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/usergroups/:usergroup_id/external_usergroups + +
    + List all external user groups for user group +

    +

    + + GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups + +
    + List all external user groups for LDAP authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/usergroups/:usergroup_id/external_usergroups/:id + +
    + Show an external user group for user group +

    +

    + + GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id + +
    + Show an external user group for LDAP authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/usergroups/:usergroup_id/external_usergroups + +
    + Create an external user group linked to a user group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup +
    + + required + + + +     		+ +

    External user group information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + external_usergroup[name] +
    + + required + + + +     		+ +

    External user group name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup[auth_source_id] +
    + + required + + + +     		+ +

    ID of linked authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup +
    + + required + + + +     		+ +

    External user group information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + external_usergroup[name] +
    + + optional + + + +     		+ +

    External user group name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup[auth_source_id] +
    + + optional + + + +     		+ +

    ID of linked authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups/create.html b/foreman/3.16/apidoc/v2/external_usergroups/create.html new file mode 100644 index 00000000..0d1baf35 --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups/create.html @@ -0,0 +1,197 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/usergroups/:usergroup_id/external_usergroups +
    + Create an external user group linked to a user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup +
    + + required + + + +     		+ +

    External user group information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + external_usergroup[name] +
    + + required + + + +     		+ +

    External user group name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup[auth_source_id] +
    + + required + + + +     		+ +

    ID of linked authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups/destroy.html b/foreman/3.16/apidoc/v2/external_usergroups/destroy.html new file mode 100644 index 00000000..e6fd1727 --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups/destroy.html @@ -0,0 +1,141 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/usergroups/:usergroup_id/external_usergroups/:id +
    + Delete an external user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups/index.html b/foreman/3.16/apidoc/v2/external_usergroups/index.html new file mode 100644 index 00000000..5cfcf340 --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups/index.html @@ -0,0 +1,120 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/usergroups/:usergroup_id/external_usergroups +
    + List all external user groups for user group +

    +
    +
    +

    + GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups +
    + List all external user groups for LDAP authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups/refresh.html b/foreman/3.16/apidoc/v2/external_usergroups/refresh.html new file mode 100644 index 00000000..b287478b --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups/refresh.html @@ -0,0 +1,141 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/usergroups/:usergroup_id/external_usergroups/:id/refresh +
    + Refresh external user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups/show.html b/foreman/3.16/apidoc/v2/external_usergroups/show.html new file mode 100644 index 00000000..4e5c1df1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups/show.html @@ -0,0 +1,148 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/usergroups/:usergroup_id/external_usergroups/:id +
    + Show an external user group for user group +

    +
    +
    +

    + GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id +
    + Show an external user group for LDAP authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/external_usergroups/update.html b/foreman/3.16/apidoc/v2/external_usergroups/update.html new file mode 100644 index 00000000..dc1f3f17 --- /dev/null +++ b/foreman/3.16/apidoc/v2/external_usergroups/update.html @@ -0,0 +1,225 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/usergroups/:usergroup_id/external_usergroups/:id +
    + Update external user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup_id +
    + + required + + + +     		+ +

    ID or name of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of external user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup +
    + + required + + + +     		+ +

    External user group information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + external_usergroup[name] +
    + + optional + + + +     		+ +

    External user group name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + external_usergroup[auth_source_id] +
    + + optional + + + +     		+ +

    ID of linked authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/fact_values.html b/foreman/3.16/apidoc/v2/fact_values.html new file mode 100644 index 00000000..a5899a9b --- /dev/null +++ b/foreman/3.16/apidoc/v2/fact_values.html @@ -0,0 +1,376 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Fact_values +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/fact_values + +
    + List all fact values +

    +

    + + GET /api/hosts/:host_id/facts + +
    + List all fact values of a given host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    factstring
    fact_short_namestring
    factsstring
    hoststring
    host.hostgroupstring
    host_idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    originstring
    reported_atdatetime
    short_namestring
    typestring
    valuestring
    + + + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/fact_values/index.html b/foreman/3.16/apidoc/v2/fact_values/index.html new file mode 100644 index 00000000..0208f6f4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/fact_values/index.html @@ -0,0 +1,353 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/fact_values +
    + List all fact values +

    +
    +
    +

    + GET /api/hosts/:host_id/facts +
    + List all fact values of a given host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    factstring
    fact_short_namestring
    factsstring
    hoststring
    host.hostgroupstring
    host_idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    originstring
    reported_atdatetime
    short_namestring
    typestring
    valuestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/filters.html b/foreman/3.16/apidoc/v2/filters.html new file mode 100644 index 00000000..4053b975 --- /dev/null +++ b/foreman/3.16/apidoc/v2/filters.html @@ -0,0 +1,1181 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Filters +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/filters + +
    + List all filters +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    limitedtrue, false
    locationstring
    location_idinteger
    organizationstring
    organization_idinteger
    overridetrue, false
    permissionstring
    resourcestring
    rolestring
    role_idinteger
    searchtext
    unlimitedtrue, false
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/filters/:id + +
    + Show a filter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/filters + +
    + Create a filter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + filter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + filter[role_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[search] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[override] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + filter[permission_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/filters/:id + +
    + Update a filter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + filter[role_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[search] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[override] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + filter[permission_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/filters/:id + +
    + Delete a filter +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/filters/create.html b/foreman/3.16/apidoc/v2/filters/create.html new file mode 100644 index 00000000..903501a0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/filters/create.html @@ -0,0 +1,321 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/filters +
    + Create a filter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + filter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + filter[role_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[search] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[override] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + filter[permission_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/filters/destroy.html b/foreman/3.16/apidoc/v2/filters/destroy.html new file mode 100644 index 00000000..65be05ec --- /dev/null +++ b/foreman/3.16/apidoc/v2/filters/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/filters/:id +
    + Delete a filter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/filters/index.html b/foreman/3.16/apidoc/v2/filters/index.html new file mode 100644 index 00000000..bccec547 --- /dev/null +++ b/foreman/3.16/apidoc/v2/filters/index.html @@ -0,0 +1,331 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/filters +
    + List all filters +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    limitedtrue, false
    locationstring
    location_idinteger
    organizationstring
    organization_idinteger
    overridetrue, false
    permissionstring
    resourcestring
    rolestring
    role_idinteger
    searchtext
    unlimitedtrue, false
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/filters/show.html b/foreman/3.16/apidoc/v2/filters/show.html new file mode 100644 index 00000000..164b12cf --- /dev/null +++ b/foreman/3.16/apidoc/v2/filters/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/filters/:id +
    + Show a filter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/filters/update.html b/foreman/3.16/apidoc/v2/filters/update.html new file mode 100644 index 00000000..c157f321 --- /dev/null +++ b/foreman/3.16/apidoc/v2/filters/update.html @@ -0,0 +1,347 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/filters/:id +
    + Update a filter +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + filter[role_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[search] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + filter[override] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + filter[permission_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + filter[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/home.html b/foreman/3.16/apidoc/v2/home.html new file mode 100644 index 00000000..4b9f2361 --- /dev/null +++ b/foreman/3.16/apidoc/v2/home.html @@ -0,0 +1,256 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Home +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api + +
    + Show available API links +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/status + +
    + Show status +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/home/index.html b/foreman/3.16/apidoc/v2/home/index.html new file mode 100644 index 00000000..33766b83 --- /dev/null +++ b/foreman/3.16/apidoc/v2/home/index.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api +
    + Show available API links +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/home/status.html b/foreman/3.16/apidoc/v2/home/status.html new file mode 100644 index 00000000..b87654ed --- /dev/null +++ b/foreman/3.16/apidoc/v2/home/status.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/status +
    + Show status +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/host_statuses.html b/foreman/3.16/apidoc/v2/host_statuses.html new file mode 100644 index 00000000..7664953b --- /dev/null +++ b/foreman/3.16/apidoc/v2/host_statuses.html @@ -0,0 +1,215 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Host_statuses +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/host_statuses + +
    + List of host statuses +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + 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$/.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/host_statuses/index.html b/foreman/3.16/apidoc/v2/host_statuses/index.html new file mode 100644 index 00000000..a88f0b8c --- /dev/null +++ b/foreman/3.16/apidoc/v2/host_statuses/index.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/host_statuses +
    + List of host statuses +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + 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$/.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups.html b/foreman/3.16/apidoc/v2/hostgroups.html new file mode 100644 index 00000000..66a3d398 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups.html @@ -0,0 +1,2701 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Hostgroups +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/hostgroups + +
    + List all host groups +

    +

    + + GET /api/locations/:location_id/hostgroups + +
    + List all host groups per location +

    +

    + + GET /api/organizations/:organization_id/hostgroups + +
    + List all host groups per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + include +
    + + optional + + + +     		+ +

    Array of extra information types to include

    + +

    Validations:

    +
      +
    • +

      Must be an array of [“parameters”]

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architecturestring
    hoststring
    idinteger
    labelstring
    locationstring
    location_idinteger
    mediumstring
    namestring
    organizationstring
    organization_idinteger
    osstring
    os_descriptionstring
    os_idinteger
    os_majorstring
    os_minorstring
    os_titlestring
    paramsstring
    templatestring
    titlestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hostgroups/:id + +
    + Show a host group +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/hostgroups/928644286
+200
+{
+  "subnet_id": null,
+  "subnet_name": null,
+  "operatingsystem_id": null,
+  "operatingsystem_name": null,
+  "domain_id": null,
+  "domain_name": null,
+  "compute_profile_id": null,
+  "compute_profile_name": null,
+  "ancestry": null,
+  "parent_id": null,
+  "parent_name": null,
+  "ptable_id": null,
+  "ptable_name": null,
+  "medium_id": null,
+  "medium_name": null,
+  "pxe_loader": null,
+  "subnet6_id": null,
+  "subnet6_name": null,
+  "compute_resource_id": null,
+  "compute_resource_name": null,
+  "architecture_id": null,
+  "architecture_name": null,
+  "realm_id": null,
+  "realm_name": null,
+  "created_at": "2025-08-20 10:25:16 UTC",
+  "updated_at": "2025-08-20 10:25:16 UTC",
+  "id": 928644286,
+  "name": "hostgroup1",
+  "title": "hostgroup1",
+  "description": null,
+  "puppet_proxy_id": null,
+  "puppet_proxy_name": null,
+  "puppet_ca_proxy_id": null,
+  "puppet_ca_proxy_name": null,
+  "puppet_proxy": null,
+  "puppet_ca_proxy": null,
+  "inherited_compute_profile_id": null,
+  "inherited_domain_id": null,
+  "inherited_puppet_proxy_id": null,
+  "inherited_puppet_ca_proxy_id": null,
+  "inherited_compute_resource_id": null,
+  "inherited_operatingsystem_id": null,
+  "inherited_architecture_id": null,
+  "inherited_medium_id": null,
+  "inherited_ptable_id": null,
+  "inherited_subnet_id": null,
+  "inherited_subnet6_id": null,
+  "inherited_realm_id": null,
+  "inherited_pxe_loader": null,
+  "parameters": [
+    {
+      "priority": 60,
+      "created_at": "2025-08-20 10:25:16 UTC",
+      "updated_at": "2025-08-20 10:25:16 UTC",
+      "id": 767575239,
+      "name": "parameter1",
+      "parameter_type": "string",
+      "associated_type": "host group",
+      "hidden_value?": false,
+      "value": "parameter value 1"
+    }
+  ],
+  "template_combinations": [],
+  "locations": [
+    {
+      "id": 255093256,
+      "name": "Location 1",
+      "title": "Location 1",
+      "description": null
+    }
+  ],
+  "organizations": [
+    {
+      "id": 447626438,
+      "name": "Organization 1",
+      "title": "Organization 1",
+      "description": null
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/hostgroups + +
    + Create a host group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + hostgroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + hostgroup[name] +
    + + required + + + +     		+ +

    Name of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[description] +
    + + optional + , nil allowed + + +     		+ +

    Host group description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute profile ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    Operating system ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    Architecture ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + hostgroup[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    Media ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    Partition table ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IPv6 ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Domain ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Realm ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + hostgroup[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    Root password on provisioned hosts

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + hostgroup[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hostgroups/:id + +
    + Update a host group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + hostgroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + hostgroup[name] +
    + + optional + + + +     		+ +

    Name of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[description] +
    + + optional + , nil allowed + + +     		+ +

    Host group description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute profile ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    Operating system ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    Architecture ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + hostgroup[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    Media ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    Partition table ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IPv6 ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Domain ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Realm ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + hostgroup[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    Root password on provisioned hosts

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + hostgroup[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/hostgroups/:id + +
    + Delete a host group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/hostgroups/:id/clone + +
    + Clone a host group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hostgroups/:id/rebuild_config + +
    + Rebuild orchestration config +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + only +
    + + optional + + + +     		+ +

    Limit rebuild steps, valid steps are DHCP, DNS, TFTP

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + children_hosts +
    + + optional + + + +     		+ +

    Operate on child hostgroup hosts

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/clone.html b/foreman/3.16/apidoc/v2/hostgroups/clone.html new file mode 100644 index 00000000..c9755902 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/clone.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/hostgroups/:id/clone +
    + Clone a host group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/create.html b/foreman/3.16/apidoc/v2/hostgroups/create.html new file mode 100644 index 00000000..de80856e --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/create.html @@ -0,0 +1,835 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/hostgroups +
    + Create a host group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + hostgroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + hostgroup[name] +
    + + required + + + +     		+ +

    Name of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[description] +
    + + optional + , nil allowed + + +     		+ +

    Host group description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute profile ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    Operating system ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    Architecture ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + hostgroup[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    Media ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    Partition table ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IPv6 ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Domain ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Realm ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + hostgroup[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    Root password on provisioned hosts

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + hostgroup[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/destroy.html b/foreman/3.16/apidoc/v2/hostgroups/destroy.html new file mode 100644 index 00000000..3d83bb27 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hostgroups/:id +
    + Delete a host group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/index.html b/foreman/3.16/apidoc/v2/hostgroups/index.html new file mode 100644 index 00000000..b026707c --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/index.html @@ -0,0 +1,403 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hostgroups +
    + List all host groups +

    +
    +
    +

    + GET /api/locations/:location_id/hostgroups +
    + List all host groups per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/hostgroups +
    + List all host groups per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + include +
    + + optional + + + +     		+ +

    Array of extra information types to include

    + +

    Validations:

    +
      +
    • +

      Must be an array of [“parameters”]

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architecturestring
    hoststring
    idinteger
    labelstring
    locationstring
    location_idinteger
    mediumstring
    namestring
    organizationstring
    organization_idinteger
    osstring
    os_descriptionstring
    os_idinteger
    os_majorstring
    os_minorstring
    os_titlestring
    paramsstring
    templatestring
    titlestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/rebuild_config.html b/foreman/3.16/apidoc/v2/hostgroups/rebuild_config.html new file mode 100644 index 00000000..d39047aa --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/rebuild_config.html @@ -0,0 +1,221 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hostgroups/:id/rebuild_config +
    + Rebuild orchestration config +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + only +
    + + optional + + + +     		+ +

    Limit rebuild steps, valid steps are DHCP, DNS, TFTP

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + children_hosts +
    + + optional + + + +     		+ +

    Operate on child hostgroup hosts

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/show.html b/foreman/3.16/apidoc/v2/hostgroups/show.html new file mode 100644 index 00000000..4e6c72e2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/show.html @@ -0,0 +1,277 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hostgroups/:id +
    + Show a host group +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/hostgroups/928644286
+200
+{
+  "subnet_id": null,
+  "subnet_name": null,
+  "operatingsystem_id": null,
+  "operatingsystem_name": null,
+  "domain_id": null,
+  "domain_name": null,
+  "compute_profile_id": null,
+  "compute_profile_name": null,
+  "ancestry": null,
+  "parent_id": null,
+  "parent_name": null,
+  "ptable_id": null,
+  "ptable_name": null,
+  "medium_id": null,
+  "medium_name": null,
+  "pxe_loader": null,
+  "subnet6_id": null,
+  "subnet6_name": null,
+  "compute_resource_id": null,
+  "compute_resource_name": null,
+  "architecture_id": null,
+  "architecture_name": null,
+  "realm_id": null,
+  "realm_name": null,
+  "created_at": "2025-08-20 10:25:16 UTC",
+  "updated_at": "2025-08-20 10:25:16 UTC",
+  "id": 928644286,
+  "name": "hostgroup1",
+  "title": "hostgroup1",
+  "description": null,
+  "puppet_proxy_id": null,
+  "puppet_proxy_name": null,
+  "puppet_ca_proxy_id": null,
+  "puppet_ca_proxy_name": null,
+  "puppet_proxy": null,
+  "puppet_ca_proxy": null,
+  "inherited_compute_profile_id": null,
+  "inherited_domain_id": null,
+  "inherited_puppet_proxy_id": null,
+  "inherited_puppet_ca_proxy_id": null,
+  "inherited_compute_resource_id": null,
+  "inherited_operatingsystem_id": null,
+  "inherited_architecture_id": null,
+  "inherited_medium_id": null,
+  "inherited_ptable_id": null,
+  "inherited_subnet_id": null,
+  "inherited_subnet6_id": null,
+  "inherited_realm_id": null,
+  "inherited_pxe_loader": null,
+  "parameters": [
+    {
+      "priority": 60,
+      "created_at": "2025-08-20 10:25:16 UTC",
+      "updated_at": "2025-08-20 10:25:16 UTC",
+      "id": 767575239,
+      "name": "parameter1",
+      "parameter_type": "string",
+      "associated_type": "host group",
+      "hidden_value?": false,
+      "value": "parameter value 1"
+    }
+  ],
+  "template_combinations": [],
+  "locations": [
+    {
+      "id": 255093256,
+      "name": "Location 1",
+      "title": "Location 1",
+      "description": null
+    }
+  ],
+  "organizations": [
+    {
+      "id": 447626438,
+      "name": "Organization 1",
+      "title": "Organization 1",
+      "description": null
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hostgroups/update.html b/foreman/3.16/apidoc/v2/hostgroups/update.html new file mode 100644 index 00000000..23821793 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hostgroups/update.html @@ -0,0 +1,861 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hostgroups/:id +
    + Update a host group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + hostgroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + hostgroup[name] +
    + + optional + + + +     		+ +

    Name of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[description] +
    + + optional + , nil allowed + + +     		+ +

    Host group description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID of the host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute profile ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    Operating system ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    Architecture ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + hostgroup[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    Media ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    Partition table ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IPv6 ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Domain ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Realm ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + hostgroup[group_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + hostgroup[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    Root password on provisioned hosts

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + hostgroup[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts.html b/foreman/3.16/apidoc/v2/hosts.html new file mode 100644 index 00000000..a7a2a2cf --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts.html @@ -0,0 +1,6925 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Hosts +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/hosts + +
    + List all hosts +

    +

    + + GET /api/hostgroups/:hostgroup_id/hosts + +
    + List all hosts for a host group +

    +

    + + GET /api/locations/:location_id/hosts + +
    + List hosts per location +

    +

    + + GET /api/organizations/:organization_id/hosts + +
    + List hosts per organization +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/v2/hosts?thin=true&page=1&per_page=10&search=
+200
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 10,
+  "search": "",
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "id": 1,
+      "name": "host17.example29.com"
+    },
+    {
+      "id": 2,
+      "name": "host18"
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + thin +
    + + optional + + + +     		+ +

    Only list ID and name of hosts

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + include +
    + + optional + + + +     		+ +

    Array of extra information types to include

    + +

    Validations:

    +
      +
    • +

      Must be one of: parameters, all_parameters.

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architecturestring
    boot_timedatetime
    buildtrue, false
    build_statusbuilt, pending, token_expired, build_failed
    commenttext
    compute_resourcestring
    compute_resource_idinteger
    configuration_status.appliedinteger
    configuration_status.enabledtrue, false
    configuration_status.failedinteger
    configuration_status.failed_restartsinteger
    configuration_status.interestingtrue, false
    configuration_status.pendinginteger
    configuration_status.restartedinteger
    configuration_status.skippedinteger
    created_atdatetime
    domainstring
    domain_idinteger
    factsstring
    global_statusok, warning, error
    has_ipstring
    has_ip6string
    has_macstring
    hostgroupstring
    hostgroup_fullnamestring
    hostgroup_idinteger
    hostgroup_namestring
    hostgroup_titlestring
    idinteger
    imagestring
    infrastructure_facet.foremantrue, false
    infrastructure_facet.smart_proxy_idinteger
    installed_atdatetime
    ipstring
    ip6string
    last_reportdatetime
    locationstring
    location_idinteger
    macstring
    managedtrue, false
    modelstring
    namestring
    organizationstring
    organization_idinteger
    originstring
    osstring
    os_descriptionstring
    os_idinteger
    os_majorstring
    os_minorstring
    os_titlestring
    ownerstring
    owner_idinteger
    owner_typestring
    paramsstring
    params_namestring
    parent_hostgroupstring
    puppet_castring
    puppet_proxy_idinteger
    puppetmasterstring
    pxe_loaderPXELinux_BIOS, PXELinux_UEFI, Grub_UEFI, Grub2_BIOS, Grub2_ELF, Grub2_UEFI, Grub2_UEFI_SecureBoot, Grub2_UEFI_HTTP, Grub2_UEFI_HTTPS, Grub2_UEFI_HTTPS_SecureBoot, iPXE_Embedded, iPXE_UEFI_HTTP, iPXE_Chain_BIOS, iPXE_Chain_UEFI
    realmstring
    realm_idinteger
    reported.bios_release_datestring
    reported.bios_vendorstring
    reported.bios_versionstring
    reported.boot_timedatetime
    reported.coresinteger
    reported.disks_totalinteger
    reported.kernel_versionstring
    reported.raminteger
    reported.socketsinteger
    reported.virtualtrue, false
    smart_proxystring
    status.appliedinteger
    status.enabledtrue, false
    status.failedinteger
    status.failed_restartsinteger
    status.interestingtrue, false
    status.pendinginteger
    status.restartedinteger
    status.skippedinteger
    subnetstring
    subnet.nametext
    subnet6string
    subnet6.nametext
    user.firstnamestring
    user.lastnamestring
    user.loginstring
    user.mailstring
    usergroupstring
    usergroup.namestring
    uuidstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id + +
    + Show a host +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/hosts/host12.example25.com?show_hidden_parameters=true
+200
+{
+  "ip": "0.0.0.10",
+  "ip6": null,
+  "last_report": null,
+  "mac": "00:53:67:ab:00:0a",
+  "realm_id": null,
+  "realm_name": null,
+  "sp_mac": null,
+  "sp_ip": null,
+  "sp_name": null,
+  "domain_id": 759776764,
+  "domain_name": "example25.com",
+  "architecture_id": 922134522,
+  "architecture_name": "x86_64-10",
+  "operatingsystem_id": 1073012829,
+  "operatingsystem_name": "operatingsystem10 10",
+  "subnet_id": null,
+  "subnet_name": null,
+  "subnet6_id": null,
+  "subnet6_name": null,
+  "sp_subnet_id": null,
+  "ptable_id": 1007981702,
+  "ptable_name": "ptable10",
+  "medium_id": 1011586619,
+  "medium_name": "medium10",
+  "pxe_loader": "Grub2 UEFI",
+  "build": false,
+  "comment": "",
+  "disk": null,
+  "initiated_at": null,
+  "installed_at": null,
+  "model_id": null,
+  "hostgroup_id": null,
+  "owner_id": 135138680,
+  "owner_name": "Admin User",
+  "owner_type": "User",
+  "creator_id": 135138680,
+  "creator": "Admin User",
+  "enabled": true,
+  "managed": true,
+  "use_image": null,
+  "image_file": "",
+  "uuid": null,
+  "compute_resource_id": null,
+  "compute_resource_name": null,
+  "compute_profile_id": null,
+  "compute_profile_name": null,
+  "capabilities": [
+    "build"
+  ],
+  "provision_method": "build",
+  "certname": "host12.example25.com",
+  "image_id": null,
+  "image_name": null,
+  "created_at": "2025-08-20 10:23:35 UTC",
+  "updated_at": "2025-08-20 10:23:35 UTC",
+  "last_compile": null,
+  "global_status": 0,
+  "global_status_label": "OK",
+  "bmc_available": false,
+  "organization_id": 447626438,
+  "organization_name": "Organization 1",
+  "location_id": 255093256,
+  "location_name": "Location 1",
+  "puppet_status": 0,
+  "model_name": null,
+  "build_status": 0,
+  "build_status_label": "Installed",
+  "name": "host12.example25.com",
+  "id": 1,
+  "display_name": "host12.example25.com",
+  "puppet_proxy_id": null,
+  "puppet_proxy_name": null,
+  "puppet_ca_proxy_id": null,
+  "puppet_ca_proxy_name": null,
+  "puppet_proxy": null,
+  "puppet_ca_proxy": null,
+  "compute_resource_provider": null,
+  "hostgroup_name": null,
+  "hostgroup_title": null,
+  "parameters": [],
+  "all_parameters": [
+    {
+      "priority": null,
+      "created_at": "2025-08-20 10:23:32 UTC",
+      "updated_at": "2025-08-20 10:23:32 UTC",
+      "id": 513706444,
+      "name": "loc_param",
+      "parameter_type": "string",
+      "associated_type": "location",
+      "hidden_value?": false,
+      "value": "abc"
+    },
+    {
+      "priority": null,
+      "created_at": "2025-08-20 10:23:32 UTC",
+      "updated_at": "2025-08-20 10:23:32 UTC",
+      "id": 32400255,
+      "name": "org_param",
+      "parameter_type": "string",
+      "associated_type": "organization",
+      "hidden_value?": false,
+      "value": "xyz"
+    },
+    {
+      "priority": null,
+      "created_at": "2025-08-20 10:23:32 UTC",
+      "updated_at": "2025-08-20 10:23:32 UTC",
+      "id": 636252244,
+      "name": "test",
+      "parameter_type": "string",
+      "associated_type": "global",
+      "hidden_value?": false,
+      "value": "myvalue"
+    }
+  ],
+  "interfaces": [
+    {
+      "subnet_id": null,
+      "subnet_name": null,
+      "subnet6_id": null,
+      "subnet6_name": null,
+      "domain_id": 759776764,
+      "domain_name": "example25.com",
+      "created_at": "2025-08-20 10:23:35 UTC",
+      "updated_at": "2025-08-20 10:23:35 UTC",
+      "managed": true,
+      "identifier": "eth10",
+      "id": 1,
+      "name": "host12.example25.com",
+      "ip": "0.0.0.10",
+      "ip6": null,
+      "mac": "00:53:67:ab:00:0a",
+      "mtu": null,
+      "fqdn": "host12.example25.com",
+      "primary": true,
+      "provision": true,
+      "type": "interface",
+      "virtual": false
+    }
+  ],
+  "permissions": {
+    "view_hosts": true,
+    "create_hosts": true,
+    "edit_hosts": true,
+    "destroy_hosts": true,
+    "build_hosts": true,
+    "power_hosts": true,
+    "console_hosts": true,
+    "ipmi_boot_hosts": true
+  }
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/hosts + +
    + Create a host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[location_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[organization_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[ip] +
    + + optional + , nil allowed + + +     		+ +

    not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[mac] +
    + + optional + , nil allowed + + +     		+ +

    required for managed host that is bare metal, not required if it's a virtual machine

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    required if not imaged based provisioning and host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + host[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and custom partition has not been defined

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    nil means host is bare metal

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group or default password in settings

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[model_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_type] +
    + + optional + , nil allowed + + +     		+ +

    Host's owner type

    + +

    Validations:

    +
      +
    • +

      Must be one of: User, Usergroup.

      +
      • +
    + + + +
    + host[image_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[host_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's parameters (array or indexed hash)

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[host_parameters_attributes][name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + host[host_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[build] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[enabled] +
    + + optional + , nil allowed + + +     		+ +

    Include this host within Foreman reporting

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[provision_method] +
    + + optional + , nil allowed + + +     		+ +

    The method used to provision the host.

    + +

    Validations:

    +
      +
    • +

      Must be one of: build, image.

      +
      • +
    + + + +
    + host[managed] +
    + + optional + , nil allowed + + +     		+ +

    True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[progress_report_id] +
    + + optional + , nil allowed + + +     		+ +

    UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[comment] +
    + + optional + , nil allowed + + +     		+ +

    Additional information about this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[capabilities] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's network interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[interfaces_attributes][id] +
    + + optional + , nil allowed + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + host[interfaces_attributes][name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + host[interfaces_attributes][virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + host[interfaces_attributes][bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[overwrite] +
    + + optional + + + +     		+ +

    Overwrite existing host (true by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:id + +
    + Update a host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + host +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[location_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[organization_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[ip] +
    + + optional + , nil allowed + + +     		+ +

    not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[mac] +
    + + optional + , nil allowed + + +     		+ +

    required for managed host that is bare metal, not required if it's a virtual machine

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    required if not imaged based provisioning and host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + host[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and custom partition has not been defined

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    nil means host is bare metal

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group or default password in settings

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[model_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_type] +
    + + optional + , nil allowed + + +     		+ +

    Host's owner type

    + +

    Validations:

    +
      +
    • +

      Must be one of: User, Usergroup.

      +
      • +
    + + + +
    + host[image_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[host_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's parameters (array or indexed hash)

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[host_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + host[host_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[build] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[enabled] +
    + + optional + , nil allowed + + +     		+ +

    Include this host within Foreman reporting

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[provision_method] +
    + + optional + , nil allowed + + +     		+ +

    The method used to provision the host.

    + +

    Validations:

    +
      +
    • +

      Must be one of: build, image.

      +
      • +
    + + + +
    + host[managed] +
    + + optional + , nil allowed + + +     		+ +

    True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[progress_report_id] +
    + + optional + , nil allowed + + +     		+ +

    UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[comment] +
    + + optional + , nil allowed + + +     		+ +

    Additional information about this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[capabilities] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's network interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[interfaces_attributes][id] +
    + + optional + , nil allowed + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + host[interfaces_attributes][name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + host[interfaces_attributes][virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + host[interfaces_attributes][bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/hosts/:id + +
    + Delete a host +

    +
    + + +
    + + + + +

    Examples

    + 
    DELETE /api/hosts/host14
+200
+{
+  "id": 2,
+  "name": "host14",
+  "last_compile": null,
+  "last_report": null,
+  "updated_at": "2025-08-20T10:23:42.953Z",
+  "created_at": "2025-08-20T10:23:42.953Z",
+  "root_pass": "$6$63rhh2jnmHmVkAq1$tpjLyjARf5nkqZuslVFZdI0mz75KFdnyDPiwwC4EMeHi.oo1cc1fMstVZNMnQ4CFQVIxOU73dQzmNMaLmx/29.",
+  "architecture_id": null,
+  "operatingsystem_id": null,
+  "ptable_id": null,
+  "medium_id": null,
+  "build": false,
+  "comment": "",
+  "disk": null,
+  "installed_at": null,
+  "model_id": null,
+  "hostgroup_id": null,
+  "owner_id": 135138680,
+  "owner_type": "User",
+  "enabled": true,
+  "puppet_ca_proxy_id": null,
+  "managed": false,
+  "use_image": null,
+  "image_file": "",
+  "uuid": null,
+  "compute_resource_id": null,
+  "puppet_proxy_id": null,
+  "certname": "host14",
+  "image_id": null,
+  "organization_id": 447626438,
+  "location_id": 255093256,
+  "otp": null,
+  "realm_id": null,
+  "compute_profile_id": null,
+  "provision_method": "build",
+  "grub_pass": null,
+  "global_status": 0,
+  "lookup_value_matcher": "fqdn=host14",
+  "pxe_loader": null,
+  "initiated_at": null,
+  "build_errors": null,
+  "creator_id": 135138680
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/enc + +
    + Get ENC values of host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/status/:type + +
    + Get status of host +

    +
    + + +
    + +

    Returns string representing a host status of a given type

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + type +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be one of: global, build, configuration.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/hosts/:id/status/:type + +
    + Clear sub-status of host +

    +
    + + +
    + +

    Clears a host sub-status of a given type

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + type +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be one of: build, configuration.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/vm_compute_attributes + +
    + Get vm attributes of host +

    +
    + + +
    + +

    Return the host's compute attributes that can be used to create a clone of this VM

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:id/disassociate + +
    + Disassociate the host from a VM +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:id/power + +
    + Run a power operation on host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + power_action +
    + + required + + + +     		+ +

    power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/power + +
    + Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs. +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/v2/hosts/host1.example1.com/power
+200
+{
+  "id": 1,
+  "state": "na",
+  "title": "N/A",
+  "statusText": "Power operations are not enabled on this host."
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + timeout +
    + + optional + + + +     		+ +

    Timeout to retrieve the power status of the host in seconds. Default is 3 seconds.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:id/boot + +
    + Boot host from specified device +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + device +
    + + required + + + +     		+ +

    boot device, valid devices are disk, cdrom, pxe, bios

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/hosts/facts + +
    + Upload facts for a host, creating the host if required +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    hostname of the host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + facts +
    + + required + + + +     		+ +

    hash containing the facts for the host

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + certname +
    + + optional + + + +     		+ +

    optional: certname of the host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + type +
    + + optional + + + +     		+ +

    optional: the STI type of host to create

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:id/rebuild_config + +
    + Rebuild orchestration config +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + only +
    + + optional + + + +     		+ +

    Limit rebuild steps, valid steps are DHCP, DNS, TFTP

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/template/:kind + +
    + Preview rendered provisioning template content +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + kind +
    + + required + + + +     		+ +

    Template kinds, available values: iPXE, provision, PXELinux, script, finish, PXEGrub, PXEGrub2, host_init_config, registration, public

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/templates + +
    + Get provisioning templates for the host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:id/inherited_parameters + +
    + Get all inherited parameters for a host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/boot.html b/foreman/3.16/apidoc/v2/hosts/boot.html new file mode 100644 index 00000000..d05816ab --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/boot.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:id/boot +
    + Boot host from specified device +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + device +
    + + required + + + +     		+ +

    boot device, valid devices are disk, cdrom, pxe, bios

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/create.html b/foreman/3.16/apidoc/v2/hosts/create.html new file mode 100644 index 00000000..6658e0ba --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/create.html @@ -0,0 +1,1877 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/hosts +
    + Create a host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[location_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[organization_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[ip] +
    + + optional + , nil allowed + + +     		+ +

    not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[mac] +
    + + optional + , nil allowed + + +     		+ +

    required for managed host that is bare metal, not required if it's a virtual machine

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    required if not imaged based provisioning and host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + host[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and custom partition has not been defined

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    nil means host is bare metal

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group or default password in settings

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[model_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_type] +
    + + optional + , nil allowed + + +     		+ +

    Host's owner type

    + +

    Validations:

    +
      +
    • +

      Must be one of: User, Usergroup.

      +
      • +
    + + + +
    + host[image_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[host_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's parameters (array or indexed hash)

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[host_parameters_attributes][name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + host[host_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[build] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[enabled] +
    + + optional + , nil allowed + + +     		+ +

    Include this host within Foreman reporting

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[provision_method] +
    + + optional + , nil allowed + + +     		+ +

    The method used to provision the host.

    + +

    Validations:

    +
      +
    • +

      Must be one of: build, image.

      +
      • +
    + + + +
    + host[managed] +
    + + optional + , nil allowed + + +     		+ +

    True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[progress_report_id] +
    + + optional + , nil allowed + + +     		+ +

    UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[comment] +
    + + optional + , nil allowed + + +     		+ +

    Additional information about this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[capabilities] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's network interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[interfaces_attributes][id] +
    + + optional + , nil allowed + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + host[interfaces_attributes][name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + host[interfaces_attributes][virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + host[interfaces_attributes][bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[overwrite] +
    + + optional + + + +     		+ +

    Overwrite existing host (true by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/destroy.html b/foreman/3.16/apidoc/v2/hosts/destroy.html new file mode 100644 index 00000000..443edac3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/destroy.html @@ -0,0 +1,212 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hosts/:id +
    + Delete a host +

    +
    + +
    + + + + + +

    Examples

    + 
    DELETE /api/hosts/host14
+200
+{
+  "id": 2,
+  "name": "host14",
+  "last_compile": null,
+  "last_report": null,
+  "updated_at": "2025-08-20T10:23:42.953Z",
+  "created_at": "2025-08-20T10:23:42.953Z",
+  "root_pass": "$6$63rhh2jnmHmVkAq1$tpjLyjARf5nkqZuslVFZdI0mz75KFdnyDPiwwC4EMeHi.oo1cc1fMstVZNMnQ4CFQVIxOU73dQzmNMaLmx/29.",
+  "architecture_id": null,
+  "operatingsystem_id": null,
+  "ptable_id": null,
+  "medium_id": null,
+  "build": false,
+  "comment": "",
+  "disk": null,
+  "installed_at": null,
+  "model_id": null,
+  "hostgroup_id": null,
+  "owner_id": 135138680,
+  "owner_type": "User",
+  "enabled": true,
+  "puppet_ca_proxy_id": null,
+  "managed": false,
+  "use_image": null,
+  "image_file": "",
+  "uuid": null,
+  "compute_resource_id": null,
+  "puppet_proxy_id": null,
+  "certname": "host14",
+  "image_id": null,
+  "organization_id": 447626438,
+  "location_id": 255093256,
+  "otp": null,
+  "realm_id": null,
+  "compute_profile_id": null,
+  "provision_method": "build",
+  "grub_pass": null,
+  "global_status": 0,
+  "lookup_value_matcher": "fqdn=host14",
+  "pxe_loader": null,
+  "initiated_at": null,
+  "build_errors": null,
+  "creator_id": 135138680
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/disassociate.html b/foreman/3.16/apidoc/v2/hosts/disassociate.html new file mode 100644 index 00000000..0518f3af --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/disassociate.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:id/disassociate +
    + Disassociate the host from a VM +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/enc.html b/foreman/3.16/apidoc/v2/hosts/enc.html new file mode 100644 index 00000000..496ed097 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/enc.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/enc +
    + Get ENC values of host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/facts.html b/foreman/3.16/apidoc/v2/hosts/facts.html new file mode 100644 index 00000000..d8f75ac0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/facts.html @@ -0,0 +1,251 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/hosts/facts +
    + Upload facts for a host, creating the host if required +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    hostname of the host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + facts +
    + + required + + + +     		+ +

    hash containing the facts for the host

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + certname +
    + + optional + + + +     		+ +

    optional: certname of the host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + type +
    + + optional + + + +     		+ +

    optional: the STI type of host to create

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/forget_status.html b/foreman/3.16/apidoc/v2/hosts/forget_status.html new file mode 100644 index 00000000..43671da0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/forget_status.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hosts/:id/status/:type +
    + Clear sub-status of host +

    +
    + +
    + + +

    Clears a host sub-status of a given type

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + type +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be one of: build, configuration.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/get_status.html b/foreman/3.16/apidoc/v2/hosts/get_status.html new file mode 100644 index 00000000..1c855925 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/get_status.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/status/:type +
    + Get status of host +

    +
    + +
    + + +

    Returns string representing a host status of a given type

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + type +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be one of: global, build, configuration.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/index.html b/foreman/3.16/apidoc/v2/hosts/index.html new file mode 100644 index 00000000..c678f8b3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/index.html @@ -0,0 +1,860 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts +
    + List all hosts +

    +
    +
    +

    + GET /api/hostgroups/:hostgroup_id/hosts +
    + List all hosts for a host group +

    +
    +
    +

    + GET /api/locations/:location_id/hosts +
    + List hosts per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/hosts +
    + List hosts per organization +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/v2/hosts?thin=true&page=1&per_page=10&search=
+200
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 10,
+  "search": "",
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "id": 1,
+      "name": "host17.example29.com"
+    },
+    {
+      "id": 2,
+      "name": "host18"
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + thin +
    + + optional + + + +     		+ +

    Only list ID and name of hosts

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + include +
    + + optional + + + +     		+ +

    Array of extra information types to include

    + +

    Validations:

    +
      +
    • +

      Must be one of: parameters, all_parameters.

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architecturestring
    boot_timedatetime
    buildtrue, false
    build_statusbuilt, pending, token_expired, build_failed
    commenttext
    compute_resourcestring
    compute_resource_idinteger
    configuration_status.appliedinteger
    configuration_status.enabledtrue, false
    configuration_status.failedinteger
    configuration_status.failed_restartsinteger
    configuration_status.interestingtrue, false
    configuration_status.pendinginteger
    configuration_status.restartedinteger
    configuration_status.skippedinteger
    created_atdatetime
    domainstring
    domain_idinteger
    factsstring
    global_statusok, warning, error
    has_ipstring
    has_ip6string
    has_macstring
    hostgroupstring
    hostgroup_fullnamestring
    hostgroup_idinteger
    hostgroup_namestring
    hostgroup_titlestring
    idinteger
    imagestring
    infrastructure_facet.foremantrue, false
    infrastructure_facet.smart_proxy_idinteger
    installed_atdatetime
    ipstring
    ip6string
    last_reportdatetime
    locationstring
    location_idinteger
    macstring
    managedtrue, false
    modelstring
    namestring
    organizationstring
    organization_idinteger
    originstring
    osstring
    os_descriptionstring
    os_idinteger
    os_majorstring
    os_minorstring
    os_titlestring
    ownerstring
    owner_idinteger
    owner_typestring
    paramsstring
    params_namestring
    parent_hostgroupstring
    puppet_castring
    puppet_proxy_idinteger
    puppetmasterstring
    pxe_loaderPXELinux_BIOS, PXELinux_UEFI, Grub_UEFI, Grub2_BIOS, Grub2_ELF, Grub2_UEFI, Grub2_UEFI_SecureBoot, Grub2_UEFI_HTTP, Grub2_UEFI_HTTPS, Grub2_UEFI_HTTPS_SecureBoot, iPXE_Embedded, iPXE_UEFI_HTTP, iPXE_Chain_BIOS, iPXE_Chain_UEFI
    realmstring
    realm_idinteger
    reported.bios_release_datestring
    reported.bios_vendorstring
    reported.bios_versionstring
    reported.boot_timedatetime
    reported.coresinteger
    reported.disks_totalinteger
    reported.kernel_versionstring
    reported.raminteger
    reported.socketsinteger
    reported.virtualtrue, false
    smart_proxystring
    status.appliedinteger
    status.enabledtrue, false
    status.failedinteger
    status.failed_restartsinteger
    status.interestingtrue, false
    status.pendinginteger
    status.restartedinteger
    status.skippedinteger
    subnetstring
    subnet.nametext
    subnet6string
    subnet6.nametext
    user.firstnamestring
    user.lastnamestring
    user.loginstring
    user.mailstring
    usergroupstring
    usergroup.namestring
    uuidstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/inherited_parameters.html b/foreman/3.16/apidoc/v2/hosts/inherited_parameters.html new file mode 100644 index 00000000..5643ea44 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/inherited_parameters.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/inherited_parameters +
    + Get all inherited parameters for a host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/power.html b/foreman/3.16/apidoc/v2/hosts/power.html new file mode 100644 index 00000000..c0646e60 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/power.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:id/power +
    + Run a power operation on host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + power_action +
    + + required + + + +     		+ +

    power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/power_status.html b/foreman/3.16/apidoc/v2/hosts/power_status.html new file mode 100644 index 00000000..4c844ab7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/power_status.html @@ -0,0 +1,202 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/power +
    + Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs. +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/v2/hosts/host1.example1.com/power
+200
+{
+  "id": 1,
+  "state": "na",
+  "title": "N/A",
+  "statusText": "Power operations are not enabled on this host."
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + timeout +
    + + optional + + + +     		+ +

    Timeout to retrieve the power status of the host in seconds. Default is 3 seconds.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/rebuild_config.html b/foreman/3.16/apidoc/v2/hosts/rebuild_config.html new file mode 100644 index 00000000..e0354d84 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/rebuild_config.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:id/rebuild_config +
    + Rebuild orchestration config +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + only +
    + + optional + + + +     		+ +

    Limit rebuild steps, valid steps are DHCP, DNS, TFTP

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/show.html b/foreman/3.16/apidoc/v2/hosts/show.html new file mode 100644 index 00000000..d2142124 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/show.html @@ -0,0 +1,348 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id +
    + Show a host +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/hosts/host12.example25.com?show_hidden_parameters=true
+200
+{
+  "ip": "0.0.0.10",
+  "ip6": null,
+  "last_report": null,
+  "mac": "00:53:67:ab:00:0a",
+  "realm_id": null,
+  "realm_name": null,
+  "sp_mac": null,
+  "sp_ip": null,
+  "sp_name": null,
+  "domain_id": 759776764,
+  "domain_name": "example25.com",
+  "architecture_id": 922134522,
+  "architecture_name": "x86_64-10",
+  "operatingsystem_id": 1073012829,
+  "operatingsystem_name": "operatingsystem10 10",
+  "subnet_id": null,
+  "subnet_name": null,
+  "subnet6_id": null,
+  "subnet6_name": null,
+  "sp_subnet_id": null,
+  "ptable_id": 1007981702,
+  "ptable_name": "ptable10",
+  "medium_id": 1011586619,
+  "medium_name": "medium10",
+  "pxe_loader": "Grub2 UEFI",
+  "build": false,
+  "comment": "",
+  "disk": null,
+  "initiated_at": null,
+  "installed_at": null,
+  "model_id": null,
+  "hostgroup_id": null,
+  "owner_id": 135138680,
+  "owner_name": "Admin User",
+  "owner_type": "User",
+  "creator_id": 135138680,
+  "creator": "Admin User",
+  "enabled": true,
+  "managed": true,
+  "use_image": null,
+  "image_file": "",
+  "uuid": null,
+  "compute_resource_id": null,
+  "compute_resource_name": null,
+  "compute_profile_id": null,
+  "compute_profile_name": null,
+  "capabilities": [
+    "build"
+  ],
+  "provision_method": "build",
+  "certname": "host12.example25.com",
+  "image_id": null,
+  "image_name": null,
+  "created_at": "2025-08-20 10:23:35 UTC",
+  "updated_at": "2025-08-20 10:23:35 UTC",
+  "last_compile": null,
+  "global_status": 0,
+  "global_status_label": "OK",
+  "bmc_available": false,
+  "organization_id": 447626438,
+  "organization_name": "Organization 1",
+  "location_id": 255093256,
+  "location_name": "Location 1",
+  "puppet_status": 0,
+  "model_name": null,
+  "build_status": 0,
+  "build_status_label": "Installed",
+  "name": "host12.example25.com",
+  "id": 1,
+  "display_name": "host12.example25.com",
+  "puppet_proxy_id": null,
+  "puppet_proxy_name": null,
+  "puppet_ca_proxy_id": null,
+  "puppet_ca_proxy_name": null,
+  "puppet_proxy": null,
+  "puppet_ca_proxy": null,
+  "compute_resource_provider": null,
+  "hostgroup_name": null,
+  "hostgroup_title": null,
+  "parameters": [],
+  "all_parameters": [
+    {
+      "priority": null,
+      "created_at": "2025-08-20 10:23:32 UTC",
+      "updated_at": "2025-08-20 10:23:32 UTC",
+      "id": 513706444,
+      "name": "loc_param",
+      "parameter_type": "string",
+      "associated_type": "location",
+      "hidden_value?": false,
+      "value": "abc"
+    },
+    {
+      "priority": null,
+      "created_at": "2025-08-20 10:23:32 UTC",
+      "updated_at": "2025-08-20 10:23:32 UTC",
+      "id": 32400255,
+      "name": "org_param",
+      "parameter_type": "string",
+      "associated_type": "organization",
+      "hidden_value?": false,
+      "value": "xyz"
+    },
+    {
+      "priority": null,
+      "created_at": "2025-08-20 10:23:32 UTC",
+      "updated_at": "2025-08-20 10:23:32 UTC",
+      "id": 636252244,
+      "name": "test",
+      "parameter_type": "string",
+      "associated_type": "global",
+      "hidden_value?": false,
+      "value": "myvalue"
+    }
+  ],
+  "interfaces": [
+    {
+      "subnet_id": null,
+      "subnet_name": null,
+      "subnet6_id": null,
+      "subnet6_name": null,
+      "domain_id": 759776764,
+      "domain_name": "example25.com",
+      "created_at": "2025-08-20 10:23:35 UTC",
+      "updated_at": "2025-08-20 10:23:35 UTC",
+      "managed": true,
+      "identifier": "eth10",
+      "id": 1,
+      "name": "host12.example25.com",
+      "ip": "0.0.0.10",
+      "ip6": null,
+      "mac": "00:53:67:ab:00:0a",
+      "mtu": null,
+      "fqdn": "host12.example25.com",
+      "primary": true,
+      "provision": true,
+      "type": "interface",
+      "virtual": false
+    }
+  ],
+  "permissions": {
+    "view_hosts": true,
+    "create_hosts": true,
+    "edit_hosts": true,
+    "destroy_hosts": true,
+    "build_hosts": true,
+    "power_hosts": true,
+    "console_hosts": true,
+    "ipmi_boot_hosts": true
+  }
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/template.html b/foreman/3.16/apidoc/v2/hosts/template.html new file mode 100644 index 00000000..b983de50 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/template.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/template/:kind +
    + Preview rendered provisioning template content +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + kind +
    + + required + + + +     		+ +

    Template kinds, available values: iPXE, provision, PXELinux, script, finish, PXEGrub, PXEGrub2, host_init_config, registration, public

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/templates.html b/foreman/3.16/apidoc/v2/hosts/templates.html new file mode 100644 index 00000000..6428e141 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/templates.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/templates +
    + Get provisioning templates for the host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/update.html b/foreman/3.16/apidoc/v2/hosts/update.html new file mode 100644 index 00000000..997cb376 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/update.html @@ -0,0 +1,1875 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:id +
    + Update a host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + host +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[location_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[organization_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[ip] +
    + + optional + , nil allowed + + +     		+ +

    not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[mac] +
    + + optional + , nil allowed + + +     		+ +

    required for managed host that is bare metal, not required if it's a virtual machine

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[realm_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[puppet_ca_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Puppet CA proxy ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[medium_id] +
    + + optional + , nil allowed + + +     		+ +

    required if not imaged based provisioning and host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[pxe_loader] +
    + + optional + , nil allowed + + +     		+ +

    DHCP filename option (Grub2/PXELinux by default)

    + +

    Validations:

    +
      +
    • +

      Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

      +
      • +
    + + + +
    + host[ptable_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and custom partition has not been defined

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    nil means host is bare metal

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[root_pass] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group or default password in settings

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[model_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[owner_type] +
    + + optional + , nil allowed + + +     		+ +

    Host's owner type

    + +

    Validations:

    +
      +
    • +

      Must be one of: User, Usergroup.

      +
      • +
    + + + +
    + host[image_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[host_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's parameters (array or indexed hash)

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[host_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + host[host_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[build] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[enabled] +
    + + optional + , nil allowed + + +     		+ +

    Include this host within Foreman reporting

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[provision_method] +
    + + optional + , nil allowed + + +     		+ +

    The method used to provision the host.

    + +

    Validations:

    +
      +
    • +

      Must be one of: build, image.

      +
      • +
    + + + +
    + host[managed] +
    + + optional + , nil allowed + + +     		+ +

    True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[progress_report_id] +
    + + optional + , nil allowed + + +     		+ +

    UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[comment] +
    + + optional + , nil allowed + + +     		+ +

    Additional information about this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[capabilities] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[compute_profile_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's network interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[interfaces_attributes][id] +
    + + optional + , nil allowed + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + host[interfaces_attributes][name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + host[interfaces_attributes][virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + host[interfaces_attributes][bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts/vm_compute_attributes.html b/foreman/3.16/apidoc/v2/hosts/vm_compute_attributes.html new file mode 100644 index 00000000..2a0de406 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts/vm_compute_attributes.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:id/vm_compute_attributes +
    + Get vm attributes of host +

    +
    + +
    + + +

    Return the host's compute attributes that can be used to create a clone of this VM

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions.html new file mode 100644 index 00000000..15605a4e --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions.html @@ -0,0 +1,1945 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Hosts_bulk_actions + +
      • + +
    + +
    +

    + Hosts_bulk_actions +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + DELETE /api/hosts/bulk + +
    + Delete multiple hosts +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + reboot +
    + + optional + + + +     		+ +

    Reboot after build. Ignored if rebuild_configuration is passed.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + rebuild_configuration +
    + + optional + + + +     		+ +

    Rebuild configuration only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/bulk/reassign_hostgroups + +
    + Reassign hostgroups +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of the hostgroup to reassign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + owner_id +
    + + required + + + +     		+ +

    ID of the owner to reassign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/bulk/disassociate + +
    + Disassociate compute resources +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/bulk/assign_organization + +
    + Assign organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    The organization ID to assign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + mismatch_setting +
    + + required + + + +     		+ +

    Fix organization on mismatch

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/bulk/assign_location + +
    + Assign location +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    The location ID to assign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + mismatch_setting +
    + + required + + + +     		+ +

    Fix location on mismatch

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_location.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_location.html new file mode 100644 index 00000000..ea6ca982 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_location.html @@ -0,0 +1,335 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/bulk/assign_location +
    + Assign location +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    The location ID to assign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + mismatch_setting +
    + + required + + + +     		+ +

    Fix location on mismatch

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_organization.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_organization.html new file mode 100644 index 00000000..6849b14b --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/assign_organization.html @@ -0,0 +1,335 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/bulk/assign_organization +
    + Assign organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    The organization ID to assign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + mismatch_setting +
    + + required + + + +     		+ +

    Fix organization on mismatch

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/build.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/build.html new file mode 100644 index 00000000..edc74eb9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/build.html @@ -0,0 +1,335 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/bulk/build +
    + Build +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + reboot +
    + + optional + + + +     		+ +

    Reboot after build. Ignored if rebuild_configuration is passed.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + rebuild_configuration +
    + + optional + + + +     		+ +

    Rebuild configuration only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/bulk_destroy.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/bulk_destroy.html new file mode 100644 index 00000000..48ddd98b --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/bulk_destroy.html @@ -0,0 +1,279 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hosts/bulk +
    + Delete multiple hosts +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/change_owner.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/change_owner.html new file mode 100644 index 00000000..497eaff9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/change_owner.html @@ -0,0 +1,307 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/bulk/change_owner +
    + Change owner +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + owner_id +
    + + required + + + +     		+ +

    ID of the owner to reassign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/disassociate.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/disassociate.html new file mode 100644 index 00000000..7af5f686 --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/disassociate.html @@ -0,0 +1,279 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/bulk/disassociate +
    + Disassociate compute resources +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/hosts_bulk_actions/reassign_hostgroup.html b/foreman/3.16/apidoc/v2/hosts_bulk_actions/reassign_hostgroup.html new file mode 100644 index 00000000..7aff983b --- /dev/null +++ b/foreman/3.16/apidoc/v2/hosts_bulk_actions/reassign_hostgroup.html @@ -0,0 +1,307 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/bulk/reassign_hostgroups +
    + Reassign hostgroups +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + required + + + +     		+ +

    ID of the organization

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + included +
    + + required + + + +     		+ +

    Hosts to include in the action

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + included[search] +
    + + optional + , nil allowed + + +     		+ +

    Search string describing which hosts to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + included[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + excluded +
    + + required + + + +     		+ +

    Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + excluded[ids] +
    + + optional + , nil allowed + + +     		+ +

    List of host ids to exclude and not perform the action on

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of the hostgroup to reassign the hosts to

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/http_proxies.html b/foreman/3.16/apidoc/v2/http_proxies.html new file mode 100644 index 00000000..9ecb9705 --- /dev/null +++ b/foreman/3.16/apidoc/v2/http_proxies.html @@ -0,0 +1,1177 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Http_proxies +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/http_proxies + +
    + List of HTTP Proxies +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    urlstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/http_proxies/:id + +
    + Show an HTTP Proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Identifier of the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/http_proxies + +
    + Create an HTTP Proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + http_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + http_proxy[name] +
    + + required + + + +     		+ +

    The HTTP Proxy name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[url] +
    + + required + + + +     		+ +

    URL of the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[username] +
    + + optional + , nil allowed + + +     		+ +

    Username used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[password] +
    + + optional + , nil allowed + + +     		+ +

    Password used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + http_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/http_proxies/:id + +
    + Update an HTTP Proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + http_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + http_proxy[name] +
    + + optional + + + +     		+ +

    The HTTP Proxy name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[url] +
    + + optional + + + +     		+ +

    URL of the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[username] +
    + + optional + , nil allowed + + +     		+ +

    Username used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[password] +
    + + optional + , nil allowed + + +     		+ +

    Password used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + http_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/http_proxies/:id + +
    + Delete an HTTP Proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/http_proxies/create.html b/foreman/3.16/apidoc/v2/http_proxies/create.html new file mode 100644 index 00000000..cfd2e844 --- /dev/null +++ b/foreman/3.16/apidoc/v2/http_proxies/create.html @@ -0,0 +1,333 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/http_proxies +
    + Create an HTTP Proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + http_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + http_proxy[name] +
    + + required + + + +     		+ +

    The HTTP Proxy name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[url] +
    + + required + + + +     		+ +

    URL of the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[username] +
    + + optional + , nil allowed + + +     		+ +

    Username used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[password] +
    + + optional + , nil allowed + + +     		+ +

    Password used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + http_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/http_proxies/destroy.html b/foreman/3.16/apidoc/v2/http_proxies/destroy.html new file mode 100644 index 00000000..df5edc36 --- /dev/null +++ b/foreman/3.16/apidoc/v2/http_proxies/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/http_proxies/:id +
    + Delete an HTTP Proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/http_proxies/index.html b/foreman/3.16/apidoc/v2/http_proxies/index.html new file mode 100644 index 00000000..71af376b --- /dev/null +++ b/foreman/3.16/apidoc/v2/http_proxies/index.html @@ -0,0 +1,301 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/http_proxies +
    + List of HTTP Proxies +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    urlstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/http_proxies/show.html b/foreman/3.16/apidoc/v2/http_proxies/show.html new file mode 100644 index 00000000..bb3c48b7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/http_proxies/show.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/http_proxies/:id +
    + Show an HTTP Proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Identifier of the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/http_proxies/update.html b/foreman/3.16/apidoc/v2/http_proxies/update.html new file mode 100644 index 00000000..aab87451 --- /dev/null +++ b/foreman/3.16/apidoc/v2/http_proxies/update.html @@ -0,0 +1,359 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/http_proxies/:id +
    + Update an HTTP Proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + http_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + http_proxy[name] +
    + + optional + + + +     		+ +

    The HTTP Proxy name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[url] +
    + + optional + + + +     		+ +

    URL of the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[username] +
    + + optional + , nil allowed + + +     		+ +

    Username used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[password] +
    + + optional + , nil allowed + + +     		+ +

    Password used to authenticate with the HTTP Proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + http_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + http_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/images.html b/foreman/3.16/apidoc/v2/images.html new file mode 100644 index 00000000..9412f33a --- /dev/null +++ b/foreman/3.16/apidoc/v2/images.html @@ -0,0 +1,1561 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Images +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/compute_resources/:compute_resource_id/images + +
    + List all images for a compute resource +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/images + +
    + List all images for operating system +

    +

    + + GET /api/architectures/:architecture_id/images + +
    + List all images for architecture +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture_id +
    + + optional + + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architectureinteger
    compute_resourcestring
    idinteger
    namestring
    operatingsysteminteger
    user_datatrue, false
    usernamestring
    + + + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture_id +
    + + optional + + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + image +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + image[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[username] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[uuid] +
    + + required + + + +     		+ +

    Template ID in the compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[password] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + image[user_data] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the image supports user data

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + image +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + image[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[username] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[uuid] +
    + + optional + + + +     		+ +

    Template ID in the compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[password] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + image[user_data] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the image supports user data

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/images/create.html b/foreman/3.16/apidoc/v2/images/create.html new file mode 100644 index 00000000..49210348 --- /dev/null +++ b/foreman/3.16/apidoc/v2/images/create.html @@ -0,0 +1,409 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/compute_resources/:compute_resource_id/images +
    + Create an image +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + image +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + image[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[username] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[uuid] +
    + + required + + + +     		+ +

    Template ID in the compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[password] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + image[user_data] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the image supports user data

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/images/destroy.html b/foreman/3.16/apidoc/v2/images/destroy.html new file mode 100644 index 00000000..19b4d6c5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/images/destroy.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/compute_resources/:compute_resource_id/images/:id +
    + Delete an image +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/images/index.html b/foreman/3.16/apidoc/v2/images/index.html new file mode 100644 index 00000000..96668750 --- /dev/null +++ b/foreman/3.16/apidoc/v2/images/index.html @@ -0,0 +1,399 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:compute_resource_id/images +
    + List all images for a compute resource +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/images +
    + List all images for operating system +

    +
    +
    +

    + GET /api/architectures/:architecture_id/images +
    + List all images for architecture +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture_id +
    + + optional + + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architectureinteger
    compute_resourcestring
    idinteger
    namestring
    operatingsysteminteger
    user_datatrue, false
    usernamestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/images/show.html b/foreman/3.16/apidoc/v2/images/show.html new file mode 100644 index 00000000..49590ca8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/images/show.html @@ -0,0 +1,263 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/compute_resources/:compute_resource_id/images/:id +
    + Show an image +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/images/:id +
    + Show an image +

    +
    +
    +

    + GET /api/architectures/:architecture_id/images/:id +
    + Show an image +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + compute_resource_id +
    + + optional + + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture_id +
    + + optional + + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/images/update.html b/foreman/3.16/apidoc/v2/images/update.html new file mode 100644 index 00000000..407a0cc4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/images/update.html @@ -0,0 +1,435 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/compute_resources/:compute_resource_id/images/:id +
    + Update an image +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + compute_resource_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + image +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + image[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[username] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[uuid] +
    + + optional + + + +     		+ +

    Template ID in the compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[password] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[compute_resource_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of compute resource

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[architecture_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + image[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + image[user_data] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the image supports user data

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/instance_hosts.html b/foreman/3.16/apidoc/v2/instance_hosts.html new file mode 100644 index 00000000..8615d4a4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/instance_hosts.html @@ -0,0 +1,379 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Instance_hosts +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + PUT /api/instance_hosts/:host_id + +
    + Assign a host to the Foreman instance +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/instance_hosts + +
    + List hosts forming the Foreman instance +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DESTROY /api/instance_hosts/:host_id + +
    + Unassign a given host from the Foreman instance +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/instance_hosts/destroy.html b/foreman/3.16/apidoc/v2/instance_hosts/destroy.html new file mode 100644 index 00000000..84cec41d --- /dev/null +++ b/foreman/3.16/apidoc/v2/instance_hosts/destroy.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DESTROY /api/instance_hosts/:host_id +
    + Unassign a given host from the Foreman instance +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/instance_hosts/index.html b/foreman/3.16/apidoc/v2/instance_hosts/index.html new file mode 100644 index 00000000..8a438ef4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/instance_hosts/index.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/instance_hosts +
    + List hosts forming the Foreman instance +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/instance_hosts/update.html b/foreman/3.16/apidoc/v2/instance_hosts/update.html new file mode 100644 index 00000000..c3bf4b0a --- /dev/null +++ b/foreman/3.16/apidoc/v2/instance_hosts/update.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/instance_hosts/:host_id +
    + Assign a host to the Foreman instance +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/interfaces.html b/foreman/3.16/apidoc/v2/interfaces.html new file mode 100644 index 00000000..f9f46a14 --- /dev/null +++ b/foreman/3.16/apidoc/v2/interfaces.html @@ -0,0 +1,2247 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Interfaces +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:host_id/interfaces + +
    + List all interfaces for host +

    +

    + + GET /api/domains/:domain_id/interfaces + +
    + List all interfaces for domain +

    +

    + + GET /api/subnets/:subnet_id/interfaces + +
    + List all interfaces for subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID or name of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID or name of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a 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 /api/hosts/:host_id/interfaces/:id + +
    + Show an interface for host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/hosts/:host_id/interfaces + +
    + Create an interface on a host +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface +
    + + required + + + +     		+ +

    interface information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + interface[mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + interface[name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + interface[virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interface[attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + interface[attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + interface[bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:host_id/interfaces/:id + +
    + Update a host's interface +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + interface +
    + + required + + + +     		+ +

    interface information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + interface[mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + interface[name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + interface[virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interface[attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + interface[attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + interface[bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/hosts/:host_id/interfaces/:id + +
    + Delete a host's interface +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/interfaces/create.html b/foreman/3.16/apidoc/v2/interfaces/create.html new file mode 100644 index 00000000..f9ed09e8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/interfaces/create.html @@ -0,0 +1,839 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/hosts/:host_id/interfaces +
    + Create an interface on a host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface +
    + + required + + + +     		+ +

    interface information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + interface[mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + interface[name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + interface[virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interface[attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + interface[attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + interface[bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/interfaces/destroy.html b/foreman/3.16/apidoc/v2/interfaces/destroy.html new file mode 100644 index 00000000..3f78f770 --- /dev/null +++ b/foreman/3.16/apidoc/v2/interfaces/destroy.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hosts/:host_id/interfaces/:id +
    + Delete a host's interface +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/interfaces/index.html b/foreman/3.16/apidoc/v2/interfaces/index.html new file mode 100644 index 00000000..cf710520 --- /dev/null +++ b/foreman/3.16/apidoc/v2/interfaces/index.html @@ -0,0 +1,293 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:host_id/interfaces +
    + List all interfaces for host +

    +
    +
    +

    + GET /api/domains/:domain_id/interfaces +
    + List all interfaces for domain +

    +
    +
    +

    + GET /api/subnets/:subnet_id/interfaces +
    + List all interfaces for subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID or name of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID or name of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/interfaces/show.html b/foreman/3.16/apidoc/v2/interfaces/show.html new file mode 100644 index 00000000..782b7938 --- /dev/null +++ b/foreman/3.16/apidoc/v2/interfaces/show.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:host_id/interfaces/:id +
    + Show an interface for host +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID or name of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/interfaces/update.html b/foreman/3.16/apidoc/v2/interfaces/update.html new file mode 100644 index 00000000..51e5492b --- /dev/null +++ b/foreman/3.16/apidoc/v2/interfaces/update.html @@ -0,0 +1,867 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:host_id/interfaces/:id +
    + Update a host's interface +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host_id +
    + + required + + + +     		+ +

    ID or name of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of interface

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + interface +
    + + required + + + +     		+ +

    interface information

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + interface[mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + interface[name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + interface[identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + interface[virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + interface[tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interface[attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + interface[attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + interface[bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + interface[compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/locations.html b/foreman/3.16/apidoc/v2/locations.html new file mode 100644 index 00000000..897ef4ce --- /dev/null +++ b/foreman/3.16/apidoc/v2/locations.html @@ -0,0 +1,1764 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Locations +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/locations + +
    + List all locations +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    descriptiontext
    idinteger
    location_idinteger
    namestring
    titlestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/locations/:id + +
    + Show a location +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/locations + +
    + Create a location +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + location +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + location[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated organization IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/locations/:id + +
    + Update a location +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + location +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + location[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated organization IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/locations/:id + +
    + Delete a location +

    +
    + + +
    + + + +

    Errors

    + + + + + + + + + + + + + + + + +
    CodeDescription
    409 In case a nested entity exists
    + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/locations/create.html b/foreman/3.16/apidoc/v2/locations/create.html new file mode 100644 index 00000000..0ae93978 --- /dev/null +++ b/foreman/3.16/apidoc/v2/locations/create.html @@ -0,0 +1,609 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/locations +
    + Create a location +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + location +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + location[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated organization IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/locations/destroy.html b/foreman/3.16/apidoc/v2/locations/destroy.html new file mode 100644 index 00000000..24333f30 --- /dev/null +++ b/foreman/3.16/apidoc/v2/locations/destroy.html @@ -0,0 +1,184 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/locations/:id +
    + Delete a location +

    +
    + +
    + + + + +

    Errors

    + + + + + + + + + + + + + + + + +
    CodeDescription
    409 In case a nested entity exists
    + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/locations/index.html b/foreman/3.16/apidoc/v2/locations/index.html new file mode 100644 index 00000000..588c5ef5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/locations/index.html @@ -0,0 +1,291 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/locations +
    + List all locations +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    descriptiontext
    idinteger
    location_idinteger
    namestring
    titlestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/locations/show.html b/foreman/3.16/apidoc/v2/locations/show.html new file mode 100644 index 00000000..d6268b63 --- /dev/null +++ b/foreman/3.16/apidoc/v2/locations/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/locations/:id +
    + Show a location +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/locations/update.html b/foreman/3.16/apidoc/v2/locations/update.html new file mode 100644 index 00000000..c3dfd529 --- /dev/null +++ b/foreman/3.16/apidoc/v2/locations/update.html @@ -0,0 +1,635 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/locations/:id +
    + Update a location +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + location +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + location[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + location[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated organization IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications.html b/foreman/3.16/apidoc/v2/mail_notifications.html new file mode 100644 index 00000000..ba4d9cd9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications.html @@ -0,0 +1,1169 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Mail_notifications + +
      • + +
    + +
    +

    + Mail_notifications +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/mail_notifications + +
    + List of email notifications +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    descriptiontext
    idinteger
    namestring
    userstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/mail_notifications/:id + +
    + Show an email notification +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Numerical ID or email notification name

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/users/:user_id/mail_notifications + +
    + Add an email notification for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_notification_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interval +
    + + optional + + + +     		+ +

    Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subscription +
    + + optional + + + +     		+ +

    Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_query +
    + + optional + + + +     		+ +

    Relevant only for audit summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/users/:user_id/mail_notifications/:mail_notification_id + +
    + Update an email notification for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_notification_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interval +
    + + optional + + + +     		+ +

    Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subscription +
    + + optional + + + +     		+ +

    Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_query +
    + + optional + + + +     		+ +

    Relevant only for audit summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/users/:user_id/mail_notifications/:mail_notification_id + +
    + Remove an email notification for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_notification_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/users/:user_id/mail_notifications + +
    + List all email notifications for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications/create.html b/foreman/3.16/apidoc/v2/mail_notifications/create.html new file mode 100644 index 00000000..f2c1133c --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications/create.html @@ -0,0 +1,275 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/users/:user_id/mail_notifications +
    + Add an email notification for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_notification_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interval +
    + + optional + + + +     		+ +

    Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subscription +
    + + optional + + + +     		+ +

    Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_query +
    + + optional + + + +     		+ +

    Relevant only for audit summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications/destroy.html b/foreman/3.16/apidoc/v2/mail_notifications/destroy.html new file mode 100644 index 00000000..0fe10f92 --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications/destroy.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/users/:user_id/mail_notifications/:mail_notification_id +
    + Remove an email notification for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_notification_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications/index.html b/foreman/3.16/apidoc/v2/mail_notifications/index.html new file mode 100644 index 00000000..8e74402c --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications/index.html @@ -0,0 +1,286 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/mail_notifications +
    + List of email notifications +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    descriptiontext
    idinteger
    namestring
    userstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications/show.html b/foreman/3.16/apidoc/v2/mail_notifications/show.html new file mode 100644 index 00000000..e2a7f435 --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications/show.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/mail_notifications/:id +
    + Show an email notification +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Numerical ID or email notification name

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications/update.html b/foreman/3.16/apidoc/v2/mail_notifications/update.html new file mode 100644 index 00000000..dcee3009 --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications/update.html @@ -0,0 +1,275 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/users/:user_id/mail_notifications/:mail_notification_id +
    + Update an email notification for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_notification_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + interval +
    + + optional + + + +     		+ +

    Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subscription +
    + + optional + + + +     		+ +

    Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + mail_query +
    + + optional + + + +     		+ +

    Relevant only for audit summary notification

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/mail_notifications/user_mail_notifications.html b/foreman/3.16/apidoc/v2/mail_notifications/user_mail_notifications.html new file mode 100644 index 00000000..3fb640d4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/mail_notifications/user_mail_notifications.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/mail_notifications +
    + List all email notifications for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/media.html b/foreman/3.16/apidoc/v2/media.html new file mode 100644 index 00000000..0c484e3d --- /dev/null +++ b/foreman/3.16/apidoc/v2/media.html @@ -0,0 +1,1242 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Media +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/media + +
    + List all installation media +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/media + +
    + List all media for an operating system +

    +

    + + GET /api/locations/:location_id/media + +
    + List all media per location +

    +

    + + GET /api/organizations/:organization_id/media + +
    + List all media per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    familystring
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    pathstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/media/:id + +
    + Show a medium +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/media + +
    + Create a medium +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + medium +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + medium[name] +
    + + required + + + +     		+ +

    Name of media

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[path] +
    + + required + + + +     		+ +

    The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

    + +

    for example mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host's actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

    + +

    Solaris and Debian media may also use $release.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/media/:id + +
    + Update a medium +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + medium[name] +
    + + optional + + + +     		+ +

    Name of media

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[path] +
    + + optional + + + +     		+ +

    The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

    + +

    for example mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host's actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

    + +

    Solaris and Debian media may also use $release.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/media/:id + +
    + Delete a medium +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/media/create.html b/foreman/3.16/apidoc/v2/media/create.html new file mode 100644 index 00000000..1a4070ae --- /dev/null +++ b/foreman/3.16/apidoc/v2/media/create.html @@ -0,0 +1,335 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/media +
    + Create a medium +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + medium +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + medium[name] +
    + + required + + + +     		+ +

    Name of media

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[path] +
    + + required + + + +     		+ +

    The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

    + +

    for example mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host's actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

    + +

    Solaris and Debian media may also use $release.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/media/destroy.html b/foreman/3.16/apidoc/v2/media/destroy.html new file mode 100644 index 00000000..bcdba402 --- /dev/null +++ b/foreman/3.16/apidoc/v2/media/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/media/:id +
    + Delete a medium +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/media/index.html b/foreman/3.16/apidoc/v2/media/index.html new file mode 100644 index 00000000..e0cf355a --- /dev/null +++ b/foreman/3.16/apidoc/v2/media/index.html @@ -0,0 +1,355 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/media +
    + List all installation media +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/media +
    + List all media for an operating system +

    +
    +
    +

    + GET /api/locations/:location_id/media +
    + List all media per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/media +
    + List all media per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    familystring
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    pathstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/media/show.html b/foreman/3.16/apidoc/v2/media/show.html new file mode 100644 index 00000000..1c7b506b --- /dev/null +++ b/foreman/3.16/apidoc/v2/media/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/media/:id +
    + Show a medium +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/media/update.html b/foreman/3.16/apidoc/v2/media/update.html new file mode 100644 index 00000000..2c0407c7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/media/update.html @@ -0,0 +1,361 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/media/:id +
    + Update a medium +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + medium[name] +
    + + optional + + + +     		+ +

    Name of media

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[path] +
    + + optional + + + +     		+ +

    The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

    + +

    for example mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host's actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

    + +

    Solaris and Debian media may also use $release.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + medium[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/models.html b/foreman/3.16/apidoc/v2/models.html new file mode 100644 index 00000000..38d5a462 --- /dev/null +++ b/foreman/3.16/apidoc/v2/models.html @@ -0,0 +1,1079 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Models +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/models + +
    + List all hardware models +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/models?include_permissions=true&search=
+200
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 20,
+  "search": "",
+  "can_create": true,
+  "can_edit": true,
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "info": "Virtual Machine",
+      "created_at": "2025-08-20 10:37:23 UTC",
+      "updated_at": "2025-08-20 10:37:23 UTC",
+      "vendor_class": null,
+      "hardware_model": null,
+      "id": 980190962,
+      "name": "KVM",
+      "can_edit": true,
+      "can_delete": true,
+      "hosts_count": 0
+    },
+    {
+      "info": null,
+      "created_at": "2025-08-20 10:37:23 UTC",
+      "updated_at": "2025-08-20 10:37:23 UTC",
+      "vendor_class": "Sun-Fire-V210",
+      "hardware_model": "SUN4U",
+      "id": 139037058,
+      "name": "SUN V210",
+      "can_edit": true,
+      "can_delete": true,
+      "hosts_count": 0
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    hardware_modelstring
    idinteger
    infotext
    namestring
    vendor_classstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/models/:id + +
    + Show a hardware model +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/models + +
    + Create a hardware model +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + model +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + model[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[info] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[vendor_class] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[hardware_model] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/models/:id + +
    + Update a hardware model +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + model[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[info] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[vendor_class] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[hardware_model] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/models/:id + +
    + Delete a hardware model +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/models/create.html b/foreman/3.16/apidoc/v2/models/create.html new file mode 100644 index 00000000..41006855 --- /dev/null +++ b/foreman/3.16/apidoc/v2/models/create.html @@ -0,0 +1,269 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/models +
    + Create a hardware model +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + model +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + model[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[info] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[vendor_class] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[hardware_model] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/models/destroy.html b/foreman/3.16/apidoc/v2/models/destroy.html new file mode 100644 index 00000000..920846a4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/models/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/models/:id +
    + Delete a hardware model +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/models/index.html b/foreman/3.16/apidoc/v2/models/index.html new file mode 100644 index 00000000..6338f28d --- /dev/null +++ b/foreman/3.16/apidoc/v2/models/index.html @@ -0,0 +1,333 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/models +
    + List all hardware models +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/models?include_permissions=true&search=
+200
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 20,
+  "search": "",
+  "can_create": true,
+  "can_edit": true,
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "info": "Virtual Machine",
+      "created_at": "2025-08-20 10:37:23 UTC",
+      "updated_at": "2025-08-20 10:37:23 UTC",
+      "vendor_class": null,
+      "hardware_model": null,
+      "id": 980190962,
+      "name": "KVM",
+      "can_edit": true,
+      "can_delete": true,
+      "hosts_count": 0
+    },
+    {
+      "info": null,
+      "created_at": "2025-08-20 10:37:23 UTC",
+      "updated_at": "2025-08-20 10:37:23 UTC",
+      "vendor_class": "Sun-Fire-V210",
+      "hardware_model": "SUN4U",
+      "id": 139037058,
+      "name": "SUN V210",
+      "can_edit": true,
+      "can_delete": true,
+      "hosts_count": 0
+    }
+  ]
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    hardware_modelstring
    idinteger
    infotext
    namestring
    vendor_classstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/models/show.html b/foreman/3.16/apidoc/v2/models/show.html new file mode 100644 index 00000000..583ebc03 --- /dev/null +++ b/foreman/3.16/apidoc/v2/models/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/models/:id +
    + Show a hardware model +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/models/update.html b/foreman/3.16/apidoc/v2/models/update.html new file mode 100644 index 00000000..cb929671 --- /dev/null +++ b/foreman/3.16/apidoc/v2/models/update.html @@ -0,0 +1,295 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/models/:id +
    + Update a hardware model +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + model[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[info] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[vendor_class] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + model[hardware_model] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems.html b/foreman/3.16/apidoc/v2/operatingsystems.html new file mode 100644 index 00000000..ed6fcedd --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems.html @@ -0,0 +1,2059 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Operating systems + +
      • + +
    + +
    +

    + Operating systems +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/operatingsystems + +
    + List all operating systems +

    +

    + + GET /api/architectures/:architecture_id/operatingsystems + +
    + List all operating systems for nested architecture +

    +

    + + GET /api/media/:medium_id/operatingsystems + +
    + List all operating systems for nested medium +

    +

    + + GET /api/ptables/:ptable_id/operatingsystems + +
    + List all operating systems for nested partition table +

    +

    + + GET /api/provisioning_templates/:provisioning_template_id/operatingsystems + +
    + List all operating systems for nested provisioning template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + architecture_id +
    + + optional + + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium_id +
    + + optional + + + +     		+ +

    ID of medium

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable_id +
    + + optional + + + +     		+ +

    ID of partition table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + os_parameters_attributes +
    + + optional + + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + os_parameters_attributes[name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + os_parameters_attributes[value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architecturestring
    descriptionstring
    familystring
    idinteger
    majorstring
    mediumstring
    minorstring
    namestring
    paramsstring
    templatestring
    titlestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/operatingsystems/:id + +
    + Show an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/operatingsystems + +
    + Create an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + operatingsystem[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must match regular expression /\A(\S+)\Z/.

      +
      • +
    + + + +
    + operatingsystem[major] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[minor] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[release_name] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[password_hash] +
    + + optional + , nil allowed + + +     		+ +

    Root password hash function to use

    + +

    Validations:

    +
      +
    • +

      Must be one of: SHA512, SHA256, Base64, Base64-Windows, MD5.

      +
      • +
    + + + +
    + operatingsystem[architecture_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated architectures

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated provisioning templates

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated media

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated partition tables

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/operatingsystems/:id + +
    + Update an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + operatingsystem[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must match regular expression /\A(\S+)\Z/.

      +
      • +
    + + + +
    + operatingsystem[major] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[minor] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[release_name] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[password_hash] +
    + + optional + , nil allowed + + +     		+ +

    Root password hash function to use

    + +

    Validations:

    +
      +
    • +

      Must be one of: SHA512, SHA256, Base64, Base64-Windows, MD5.

      +
      • +
    + + + +
    + operatingsystem[architecture_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated architectures

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated provisioning templates

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated media

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated partition tables

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/operatingsystems/:id + +
    + Delete an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/operatingsystems/:id/bootfiles + + DEPRECATED +
    + List boot files for an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems/bootfiles.html b/foreman/3.16/apidoc/v2/operatingsystems/bootfiles.html new file mode 100644 index 00000000..a081398c --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems/bootfiles.html @@ -0,0 +1,218 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/operatingsystems/:id/bootfiles + DEPRECATED +
    + List boot files for an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + architecture +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems/create.html b/foreman/3.16/apidoc/v2/operatingsystems/create.html new file mode 100644 index 00000000..57087038 --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems/create.html @@ -0,0 +1,545 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/operatingsystems +
    + Create an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + operatingsystem[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must match regular expression /\A(\S+)\Z/.

      +
      • +
    + + + +
    + operatingsystem[major] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[minor] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[release_name] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[password_hash] +
    + + optional + , nil allowed + + +     		+ +

    Root password hash function to use

    + +

    Validations:

    +
      +
    • +

      Must be one of: SHA512, SHA256, Base64, Base64-Windows, MD5.

      +
      • +
    + + + +
    + operatingsystem[architecture_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated architectures

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated provisioning templates

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated media

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated partition tables

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems/destroy.html b/foreman/3.16/apidoc/v2/operatingsystems/destroy.html new file mode 100644 index 00000000..d7e982ba --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/operatingsystems/:id +
    + Delete an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems/index.html b/foreman/3.16/apidoc/v2/operatingsystems/index.html new file mode 100644 index 00000000..ab65d891 --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems/index.html @@ -0,0 +1,545 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/operatingsystems +
    + List all operating systems +

    +
    +
    +

    + GET /api/architectures/:architecture_id/operatingsystems +
    + List all operating systems for nested architecture +

    +
    +
    +

    + GET /api/media/:medium_id/operatingsystems +
    + List all operating systems for nested medium +

    +
    +
    +

    + GET /api/ptables/:ptable_id/operatingsystems +
    + List all operating systems for nested partition table +

    +
    +
    +

    + GET /api/provisioning_templates/:provisioning_template_id/operatingsystems +
    + List all operating systems for nested provisioning template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + architecture_id +
    + + optional + + + +     		+ +

    ID of architecture

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + medium_id +
    + + optional + + + +     		+ +

    ID of medium

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable_id +
    + + optional + + + +     		+ +

    ID of partition table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + os_parameters_attributes +
    + + optional + + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + os_parameters_attributes[name] +
    + + required + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + os_parameters_attributes[value] +
    + + required + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    architecturestring
    descriptionstring
    familystring
    idinteger
    majorstring
    mediumstring
    minorstring
    namestring
    paramsstring
    templatestring
    titlestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems/show.html b/foreman/3.16/apidoc/v2/operatingsystems/show.html new file mode 100644 index 00000000..3ddebc93 --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/operatingsystems/:id +
    + Show an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/operatingsystems/update.html b/foreman/3.16/apidoc/v2/operatingsystems/update.html new file mode 100644 index 00000000..4652a58a --- /dev/null +++ b/foreman/3.16/apidoc/v2/operatingsystems/update.html @@ -0,0 +1,571 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/operatingsystems/:id +
    + Update an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + operatingsystem[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must match regular expression /\A(\S+)\Z/.

      +
      • +
    + + + +
    + operatingsystem[major] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[minor] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[release_name] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[os_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem[password_hash] +
    + + optional + , nil allowed + + +     		+ +

    Root password hash function to use

    + +

    Validations:

    +
      +
    • +

      Must be one of: SHA512, SHA256, Base64, Base64-Windows, MD5.

      +
      • +
    + + + +
    + operatingsystem[architecture_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated architectures

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated provisioning templates

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated media

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + operatingsystem[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    IDs of associated partition tables

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/organizations.html b/foreman/3.16/apidoc/v2/organizations.html new file mode 100644 index 00000000..e0c63a61 --- /dev/null +++ b/foreman/3.16/apidoc/v2/organizations.html @@ -0,0 +1,1764 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Organizations +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/organizations + +
    + List all organizations +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    descriptiontext
    idinteger
    namestring
    organization_idinteger
    titlestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/organizations/:id + +
    + Show an organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/organizations + +
    + Create an organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + organization[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + organization[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated location IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/organizations/:id + +
    + Update an organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + organization[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + organization[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated location IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/organizations/:id + +
    + Delete an organization +

    +
    + + +
    + + + +

    Errors

    + + + + + + + + + + + + + + + + +
    CodeDescription
    409 In case a nested entity exists
    + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/organizations/create.html b/foreman/3.16/apidoc/v2/organizations/create.html new file mode 100644 index 00000000..9de799d8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/organizations/create.html @@ -0,0 +1,609 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/organizations +
    + Create an organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + organization[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + organization[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated location IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/organizations/destroy.html b/foreman/3.16/apidoc/v2/organizations/destroy.html new file mode 100644 index 00000000..b49976c3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/organizations/destroy.html @@ -0,0 +1,184 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/organizations/:id +
    + Delete an organization +

    +
    + +
    + + + + +

    Errors

    + + + + + + + + + + + + + + + + +
    CodeDescription
    409 In case a nested entity exists
    + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/organizations/index.html b/foreman/3.16/apidoc/v2/organizations/index.html new file mode 100644 index 00000000..297aa970 --- /dev/null +++ b/foreman/3.16/apidoc/v2/organizations/index.html @@ -0,0 +1,291 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/organizations +
    + List all organizations +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    descriptiontext
    idinteger
    namestring
    organization_idinteger
    titlestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/organizations/show.html b/foreman/3.16/apidoc/v2/organizations/show.html new file mode 100644 index 00000000..4fae0517 --- /dev/null +++ b/foreman/3.16/apidoc/v2/organizations/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/organizations/:id +
    + Show an organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/organizations/update.html b/foreman/3.16/apidoc/v2/organizations/update.html new file mode 100644 index 00000000..1cb5b735 --- /dev/null +++ b/foreman/3.16/apidoc/v2/organizations/update.html @@ -0,0 +1,635 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/organizations/:id +
    + Update an organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + organization[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    User IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[smart_proxy_ids] +
    + + optional + , nil allowed + + +     		+ +

    Smart proxy IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[compute_resource_ids] +
    + + optional + , nil allowed + + +     		+ +

    Compute resource IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[medium_ids] +
    + + optional + , nil allowed + + +     		+ +

    Medium IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[ptable_ids] +
    + + optional + , nil allowed + + +     		+ +

    Partition template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[provisioning_template_ids] +
    + + optional + , nil allowed + + +     		+ +

    Provisioning template IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domain IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[realm_ids] +
    + + optional + , nil allowed + + +     		+ +

    Realm IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Host group IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[environment_ids] +
    + + optional + , nil allowed + + +     		+ +

    Environment IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[subnet_ids] +
    + + optional + , nil allowed + + +     		+ +

    Subnet IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[parent_id] +
    + + optional + , nil allowed + + +     		+ +

    Parent ID

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + organization[ignore_types] +
    + + optional + , nil allowed + + +     		+ +

    List of resources types that will be automatically associated

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + organization[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    Associated location IDs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/os_default_templates.html b/foreman/3.16/apidoc/v2/os_default_templates.html new file mode 100644 index 00000000..99ecd235 --- /dev/null +++ b/foreman/3.16/apidoc/v2/os_default_templates.html @@ -0,0 +1,1019 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Os_default_templates + +
      • + +
    + +
    +

    + Os_default_templates +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/operatingsystems/:operatingsystem_id/os_default_templates + +
    + List default templates combinations for an operating system +

    +

    + + GET /api/provisioning_templates/:provisioning_template_id/os_default_templates + +
    + List operating systems where this template is set as a default +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of provisioning template

    + +

    Validations:

    +
      +
    • +

      Must be a 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 /api/operatingsystems/:operatingsystem_id/os_default_templates/:id + +
    + Show a default template combination for an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/operatingsystems/:operatingsystem_id/os_default_templates + +
    + Create a default template combination for an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + os_default_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + os_default_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + os_default_template[provisioning_template_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of provisioning template

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/operatingsystems/:operatingsystem_id/os_default_templates/:id + +
    + Update a default template combination for an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + os_default_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + os_default_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + os_default_template[provisioning_template_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of provisioning template

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/operatingsystems/:operatingsystem_id/os_default_templates/:id + +
    + Delete a default template combination for an operating system +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/os_default_templates/create.html b/foreman/3.16/apidoc/v2/os_default_templates/create.html new file mode 100644 index 00000000..046ade39 --- /dev/null +++ b/foreman/3.16/apidoc/v2/os_default_templates/create.html @@ -0,0 +1,247 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/operatingsystems/:operatingsystem_id/os_default_templates +
    + Create a default template combination for an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + os_default_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + os_default_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + os_default_template[provisioning_template_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of provisioning template

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/os_default_templates/destroy.html b/foreman/3.16/apidoc/v2/os_default_templates/destroy.html new file mode 100644 index 00000000..0589d4cb --- /dev/null +++ b/foreman/3.16/apidoc/v2/os_default_templates/destroy.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/operatingsystems/:operatingsystem_id/os_default_templates/:id +
    + Delete a default template combination for an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/os_default_templates/index.html b/foreman/3.16/apidoc/v2/os_default_templates/index.html new file mode 100644 index 00000000..553e6f4c --- /dev/null +++ b/foreman/3.16/apidoc/v2/os_default_templates/index.html @@ -0,0 +1,258 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/operatingsystems/:operatingsystem_id/os_default_templates +
    + List default templates combinations for an operating system +

    +
    +
    +

    + GET /api/provisioning_templates/:provisioning_template_id/os_default_templates +
    + List operating systems where this template is set as a default +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of provisioning template

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/os_default_templates/show.html b/foreman/3.16/apidoc/v2/os_default_templates/show.html new file mode 100644 index 00000000..64499184 --- /dev/null +++ b/foreman/3.16/apidoc/v2/os_default_templates/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/operatingsystems/:operatingsystem_id/os_default_templates/:id +
    + Show a default template combination for an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/os_default_templates/update.html b/foreman/3.16/apidoc/v2/os_default_templates/update.html new file mode 100644 index 00000000..cd727f2c --- /dev/null +++ b/foreman/3.16/apidoc/v2/os_default_templates/update.html @@ -0,0 +1,273 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/operatingsystems/:operatingsystem_id/os_default_templates/:id +
    + Update a default template combination for an operating system +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + os_default_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + os_default_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + os_default_template[provisioning_template_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of provisioning template

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters.html b/foreman/3.16/apidoc/v2/parameters.html new file mode 100644 index 00000000..07b7f90b --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters.html @@ -0,0 +1,2447 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Parameters +
    + +

    +
    + +
    +

    These API calls are related to nested parameters for a host, domain, subnet, host group, operating system. If you are looking for <a href=“common_parameters.html”>global parameters</a>, go to <a href=“common_parameters.html”>this link</a>.

    +
    + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:host_id/parameters + +
    + List all parameters for a host +

    +

    + + GET /api/hostgroups/:hostgroup_id/parameters + +
    + List all parameters for a host group +

    +

    + + GET /api/domains/:domain_id/parameters + +
    + List all parameters for a domain +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/parameters + +
    + List all parameters for an operating system +

    +

    + + GET /api/locations/:location_id/parameters + +
    + List all parameters for a location +

    +

    + + GET /api/organizations/:organization_id/parameters + +
    + List all parameters for an organization +

    +

    + + GET /api/subnets/:subnet_id/parameters + +
    + List all parameters for a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    domain_namestring
    host_group_namestring
    host_namestring
    idinteger
    key_typestring
    location_namestring
    namestring
    organization_namestring
    os_namestring
    parameter_typestring
    subnet_nametext
    typestring
    valuetext
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/hosts/:host_id/parameters/:id + +
    + Show a nested parameter for a host +

    +

    + + GET /api/hostgroups/:hostgroup_id/parameters/:id + +
    + Show a nested parameter for a host group +

    +

    + + GET /api/domains/:domain_id/parameters/:id + +
    + Show a nested parameter for a domain +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/parameters/:id + +
    + Show a nested parameter for an operating system +

    +

    + + GET /api/locations/:location_id/parameters/:id + +
    + Show a nested parameter for a location +

    +

    + + GET /api/organizations/:organization_id/parameters/:id + +
    + Show a nested parameter for an organization +

    +

    + + GET /api/subnets/:subnet_id/parameters/:id + +
    + Show a nested parameter for a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/hosts/:host_id/parameters + +
    + Create a nested parameter for a host +

    +

    + + POST /api/hostgroups/:hostgroup_id/parameters + +
    + Create a nested parameter for a host group +

    +

    + + POST /api/domains/:domain_id/parameters + +
    + Create a nested parameter for a domain +

    +

    + + POST /api/operatingsystems/:operatingsystem_id/parameters + +
    + Create a nested parameter for an operating system +

    +

    + + POST /api/locations/:location_id/parameters + +
    + Create a nested parameter for a location +

    +

    + + POST /api/organizations/:organization_id/parameters + +
    + Create a nested parameter for an organization +

    +

    + + POST /api/subnets/:subnet_id/parameters + +
    + Create a nested parameter for a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + parameter[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[value] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[parameter_type] +
    + + required + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Should the value be hidden

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/hosts/:host_id/parameters/:id + +
    + Update a nested parameter for a host +

    +

    + + PUT /api/hostgroups/:hostgroup_id/parameters/:id + +
    + Update a nested parameter for a host group +

    +

    + + PUT /api/domains/:domain_id/parameters/:id + +
    + Update a nested parameter for a domain +

    +

    + + PUT /api/operatingsystems/:operatingsystem_id/parameters/:id + +
    + Update a nested parameter for an operating system +

    +

    + + PUT /api/locations/:location_id/parameters/:id + +
    + Update a nested parameter for a location +

    +

    + + PUT /api/organizations/:organization_id/parameters/:id + +
    + Update a nested parameter for an organization +

    +

    + + PUT /api/subnets/:subnet_id/parameters/:id + +
    + Update a nested parameter for a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + parameter[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[value] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[parameter_type] +
    + + optional + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Should the value be hidden

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/hosts/:host_id/parameters/:id + +
    + Delete a nested parameter for a host +

    +

    + + DELETE /api/hostgroups/:hostgroup_id/parameters/:id + +
    + Delete a nested parameter for a host group +

    +

    + + DELETE /api/domains/:domain_id/parameters/:id + +
    + Delete a nested parameter for a domain +

    +

    + + DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id + +
    + Delete a nested parameter for an operating system +

    +

    + + DELETE /api/locations/:location_id/parameters/:id + +
    + Delete a nested parameter for a location +

    +

    + + DELETE /api/organizations/:organization_id/parameters/:id + +
    + Delete a nested parameter for an organization +

    +

    + + DELETE /api/subnets/:subnet_id/parameters/:id + +
    + Delete a nested parameter for a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/hosts/:host_id/parameters + +
    + Delete all nested parameters for a host +

    +

    + + DELETE /api/hostgroups/:hostgroup_id/parameters + +
    + Delete all nested parameters for a host group +

    +

    + + DELETE /api/domains/:domain_id/parameters + +
    + Delete all nested parameters for a domain +

    +

    + + DELETE /api/operatingsystems/:operatingsystem_id/parameters + +
    + Delete all nested parameters for an operating system +

    +

    + + DELETE /api/locations/:location_id/parameters + +
    + Delete all nested parameter for a location +

    +

    + + DELETE /api/organizations/:organization_id/parameters + +
    + Delete all nested parameter for an organization +

    +

    + + DELETE /api/subnets/:subnet_id/parameters + +
    + Delete all nested parameters for a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters/create.html b/foreman/3.16/apidoc/v2/parameters/create.html new file mode 100644 index 00000000..930facf2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters/create.html @@ -0,0 +1,455 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/hosts/:host_id/parameters +
    + Create a nested parameter for a host +

    +
    +
    +

    + POST /api/hostgroups/:hostgroup_id/parameters +
    + Create a nested parameter for a host group +

    +
    +
    +

    + POST /api/domains/:domain_id/parameters +
    + Create a nested parameter for a domain +

    +
    +
    +

    + POST /api/operatingsystems/:operatingsystem_id/parameters +
    + Create a nested parameter for an operating system +

    +
    +
    +

    + POST /api/locations/:location_id/parameters +
    + Create a nested parameter for a location +

    +
    +
    +

    + POST /api/organizations/:organization_id/parameters +
    + Create a nested parameter for an organization +

    +
    +
    +

    + POST /api/subnets/:subnet_id/parameters +
    + Create a nested parameter for a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + parameter[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[value] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[parameter_type] +
    + + required + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Should the value be hidden

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters/destroy.html b/foreman/3.16/apidoc/v2/parameters/destroy.html new file mode 100644 index 00000000..4f2d7434 --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters/destroy.html @@ -0,0 +1,349 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hosts/:host_id/parameters/:id +
    + Delete a nested parameter for a host +

    +
    +
    +

    + DELETE /api/hostgroups/:hostgroup_id/parameters/:id +
    + Delete a nested parameter for a host group +

    +
    +
    +

    + DELETE /api/domains/:domain_id/parameters/:id +
    + Delete a nested parameter for a domain +

    +
    +
    +

    + DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id +
    + Delete a nested parameter for an operating system +

    +
    +
    +

    + DELETE /api/locations/:location_id/parameters/:id +
    + Delete a nested parameter for a location +

    +
    +
    +

    + DELETE /api/organizations/:organization_id/parameters/:id +
    + Delete a nested parameter for an organization +

    +
    +
    +

    + DELETE /api/subnets/:subnet_id/parameters/:id +
    + Delete a nested parameter for a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters/index.html b/foreman/3.16/apidoc/v2/parameters/index.html new file mode 100644 index 00000000..de125127 --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters/index.html @@ -0,0 +1,541 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:host_id/parameters +
    + List all parameters for a host +

    +
    +
    +

    + GET /api/hostgroups/:hostgroup_id/parameters +
    + List all parameters for a host group +

    +
    +
    +

    + GET /api/domains/:domain_id/parameters +
    + List all parameters for a domain +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/parameters +
    + List all parameters for an operating system +

    +
    +
    +

    + GET /api/locations/:location_id/parameters +
    + List all parameters for a location +

    +
    +
    +

    + GET /api/organizations/:organization_id/parameters +
    + List all parameters for an organization +

    +
    +
    +

    + GET /api/subnets/:subnet_id/parameters +
    + List all parameters for a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    domain_namestring
    host_group_namestring
    host_namestring
    idinteger
    key_typestring
    location_namestring
    namestring
    organization_namestring
    os_namestring
    parameter_typestring
    subnet_nametext
    typestring
    valuetext
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters/reset.html b/foreman/3.16/apidoc/v2/parameters/reset.html new file mode 100644 index 00000000..3048ae84 --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters/reset.html @@ -0,0 +1,321 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/hosts/:host_id/parameters +
    + Delete all nested parameters for a host +

    +
    +
    +

    + DELETE /api/hostgroups/:hostgroup_id/parameters +
    + Delete all nested parameters for a host group +

    +
    +
    +

    + DELETE /api/domains/:domain_id/parameters +
    + Delete all nested parameters for a domain +

    +
    +
    +

    + DELETE /api/operatingsystems/:operatingsystem_id/parameters +
    + Delete all nested parameters for an operating system +

    +
    +
    +

    + DELETE /api/locations/:location_id/parameters +
    + Delete all nested parameter for a location +

    +
    +
    +

    + DELETE /api/organizations/:organization_id/parameters +
    + Delete all nested parameter for an organization +

    +
    +
    +

    + DELETE /api/subnets/:subnet_id/parameters +
    + Delete all nested parameters for a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters/show.html b/foreman/3.16/apidoc/v2/parameters/show.html new file mode 100644 index 00000000..c0cfc1ae --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters/show.html @@ -0,0 +1,377 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/hosts/:host_id/parameters/:id +
    + Show a nested parameter for a host +

    +
    +
    +

    + GET /api/hostgroups/:hostgroup_id/parameters/:id +
    + Show a nested parameter for a host group +

    +
    +
    +

    + GET /api/domains/:domain_id/parameters/:id +
    + Show a nested parameter for a domain +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/parameters/:id +
    + Show a nested parameter for an operating system +

    +
    +
    +

    + GET /api/locations/:location_id/parameters/:id +
    + Show a nested parameter for a location +

    +
    +
    +

    + GET /api/organizations/:organization_id/parameters/:id +
    + Show a nested parameter for an organization +

    +
    +
    +

    + GET /api/subnets/:subnet_id/parameters/:id +
    + Show a nested parameter for a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + show_hidden +
    + + optional + + + +     		+ +

    Display hidden values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/parameters/update.html b/foreman/3.16/apidoc/v2/parameters/update.html new file mode 100644 index 00000000..0b8d347e --- /dev/null +++ b/foreman/3.16/apidoc/v2/parameters/update.html @@ -0,0 +1,483 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/hosts/:host_id/parameters/:id +
    + Update a nested parameter for a host +

    +
    +
    +

    + PUT /api/hostgroups/:hostgroup_id/parameters/:id +
    + Update a nested parameter for a host group +

    +
    +
    +

    + PUT /api/domains/:domain_id/parameters/:id +
    + Update a nested parameter for a domain +

    +
    +
    +

    + PUT /api/operatingsystems/:operatingsystem_id/parameters/:id +
    + Update a nested parameter for an operating system +

    +
    +
    +

    + PUT /api/locations/:location_id/parameters/:id +
    + Update a nested parameter for a location +

    +
    +
    +

    + PUT /api/organizations/:organization_id/parameters/:id +
    + Update a nested parameter for an organization +

    +
    +
    +

    + PUT /api/subnets/:subnet_id/parameters/:id +
    + Update a nested parameter for a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + host_id +
    + + optional + + + +     		+ +

    ID of host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of location

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    ID of organization

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    ID of parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet_id +
    + + optional + + + +     		+ +

    ID of subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + parameter[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[value] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + parameter[parameter_type] +
    + + optional + + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + parameter[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Should the value be hidden

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/permissions.html b/foreman/3.16/apidoc/v2/permissions.html new file mode 100644 index 00000000..d1f9fca3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/permissions.html @@ -0,0 +1,618 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Permissions +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/permissions + +
    + List all permissions +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    resource_typestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/permissions/:id + +
    + Show a permission +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/permissions/resource_types + +
    + List available resource types +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/permissions/current_permissions + +
    + List all permissions for current user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/permissions/current_permissions.html b/foreman/3.16/apidoc/v2/permissions/current_permissions.html new file mode 100644 index 00000000..ebf9c5f8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/permissions/current_permissions.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/permissions/current_permissions +
    + List all permissions for current user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/permissions/index.html b/foreman/3.16/apidoc/v2/permissions/index.html new file mode 100644 index 00000000..811a631f --- /dev/null +++ b/foreman/3.16/apidoc/v2/permissions/index.html @@ -0,0 +1,281 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/permissions +
    + List all permissions +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    resource_typestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/permissions/resource_types.html b/foreman/3.16/apidoc/v2/permissions/resource_types.html new file mode 100644 index 00000000..aca19257 --- /dev/null +++ b/foreman/3.16/apidoc/v2/permissions/resource_types.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/permissions/resource_types +
    + List available resource types +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/permissions/show.html b/foreman/3.16/apidoc/v2/permissions/show.html new file mode 100644 index 00000000..540fe029 --- /dev/null +++ b/foreman/3.16/apidoc/v2/permissions/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/permissions/:id +
    + Show a permission +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/personal_access_tokens.html b/foreman/3.16/apidoc/v2/personal_access_tokens.html new file mode 100644 index 00000000..7a24fc0a --- /dev/null +++ b/foreman/3.16/apidoc/v2/personal_access_tokens.html @@ -0,0 +1,851 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Personal_access_tokens + +
      • + +
    + +
    +

    + Personal_access_tokens +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/users/:user_id/personal_access_tokens + +
    + List all Personal Access Tokens for a user +

    +
    + + +
    + + + + +

    Examples

    + 
    GET /api/v2/users/980190962-one/personal_access_tokens?per_page=all
+200
+{
+  "total": 0,
+  "subtotal": 0,
+  "page": 1,
+  "per_page": 0,
+  "search": null,
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": []
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    user_idinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/users/:user_id/personal_access_tokens/:id + +
    + Show a Personal Access Token for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/users/:user_id/personal_access_tokens + +
    + Create a Personal Access Token for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + personal_access_token +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + personal_access_token[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + personal_access_token[expires_at] +
    + + optional + , nil allowed + + +     		+ +

    Expiry Date

    + +

    Validations:

    +
      +
    • +

      Must be a DateTime

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/users/:user_id/personal_access_tokens/:id + +
    + Revoke a Personal Access Token for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/personal_access_tokens/create.html b/foreman/3.16/apidoc/v2/personal_access_tokens/create.html new file mode 100644 index 00000000..f113c419 --- /dev/null +++ b/foreman/3.16/apidoc/v2/personal_access_tokens/create.html @@ -0,0 +1,247 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/users/:user_id/personal_access_tokens +
    + Create a Personal Access Token for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + personal_access_token +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + personal_access_token[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + personal_access_token[expires_at] +
    + + optional + , nil allowed + + +     		+ +

    Expiry Date

    + +

    Validations:

    +
      +
    • +

      Must be a DateTime

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/personal_access_tokens/destroy.html b/foreman/3.16/apidoc/v2/personal_access_tokens/destroy.html new file mode 100644 index 00000000..26660326 --- /dev/null +++ b/foreman/3.16/apidoc/v2/personal_access_tokens/destroy.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/users/:user_id/personal_access_tokens/:id +
    + Revoke a Personal Access Token for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/personal_access_tokens/index.html b/foreman/3.16/apidoc/v2/personal_access_tokens/index.html new file mode 100644 index 00000000..2dd9b46d --- /dev/null +++ b/foreman/3.16/apidoc/v2/personal_access_tokens/index.html @@ -0,0 +1,324 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/personal_access_tokens +
    + List all Personal Access Tokens for a user +

    +
    + +
    + + + + + +

    Examples

    + 
    GET /api/v2/users/980190962-one/personal_access_tokens?per_page=all
+200
+{
+  "total": 0,
+  "subtotal": 0,
+  "page": 1,
+  "per_page": 0,
+  "search": null,
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": []
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    user_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/personal_access_tokens/show.html b/foreman/3.16/apidoc/v2/personal_access_tokens/show.html new file mode 100644 index 00000000..36b0c8d0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/personal_access_tokens/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/personal_access_tokens/:id +
    + Show a Personal Access Token for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ping.html b/foreman/3.16/apidoc/v2/ping.html new file mode 100644 index 00000000..2cadff7b --- /dev/null +++ b/foreman/3.16/apidoc/v2/ping.html @@ -0,0 +1,260 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Ping +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/ping + +
    + Shows status of Foreman system and it's subcomponents +

    +
    + + +
    + +

    This service is available for unauthenticated users

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/statuses + +
    + Shows status and version information of Foreman system and it's subcomponents +

    +
    + + +
    + +

    This service is only available for authenticated users

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ping/ping.html b/foreman/3.16/apidoc/v2/ping/ping.html new file mode 100644 index 00000000..7bf9ef7c --- /dev/null +++ b/foreman/3.16/apidoc/v2/ping/ping.html @@ -0,0 +1,141 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/ping +
    + Shows status of Foreman system and it's subcomponents +

    +
    + +
    + + +

    This service is available for unauthenticated users

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ping/statuses.html b/foreman/3.16/apidoc/v2/ping/statuses.html new file mode 100644 index 00000000..5da289cf --- /dev/null +++ b/foreman/3.16/apidoc/v2/ping/statuses.html @@ -0,0 +1,141 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/statuses +
    + Shows status and version information of Foreman system and it's subcomponents +

    +
    + +
    + + +

    This service is only available for authenticated users

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/plugins.html b/foreman/3.16/apidoc/v2/plugins.html new file mode 100644 index 00000000..31f7a3c1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/plugins.html @@ -0,0 +1,159 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Plugins +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/plugins + +
    + List installed plugins +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/plugins/index.html b/foreman/3.16/apidoc/v2/plugins/index.html new file mode 100644 index 00000000..732215cc --- /dev/null +++ b/foreman/3.16/apidoc/v2/plugins/index.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/plugins +
    + List installed plugins +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates.html b/foreman/3.16/apidoc/v2/provisioning_templates.html new file mode 100644 index 00000000..48a841e7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates.html @@ -0,0 +1,2427 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Provisioning_templates + +
      • + +
    + +
    +

    + Provisioning_templates +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/provisioning_templates + +
    + List provisioning templates +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/provisioning_templates + +
    + List provisioning templates per operating system +

    +

    + + GET /api/locations/:location_id/provisioning_templates + +
    + List provisioning templates per location +

    +

    + + GET /api/organizations/:organization_id/provisioning_templates + +
    + List provisioning templates per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    default_templatetrue, false
    hostgroupstring
    idinteger
    kindstring
    locationstring
    location_idinteger
    lockedtrue, false
    namestring
    operatingsystemstring
    organizationstring
    organization_idinteger
    snippettrue, false
    templatetext
    vendorstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/provisioning_templates/:id + +
    + Show provisioning template details +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/provisioning_templates + +
    + Create a provisioning template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    not relevant for snippet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + provisioning_template[template_combinations_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of template combinations (hostgroup_id, environment_id)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the template

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/provisioning_templates/import + +
    + Import a provisioning template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template] +
    + + optional + + + +     		+ +

    template contents including metadata

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + options +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + options[force] +
    + + optional + , nil allowed + + +     		+ +

    use if you want update locked templates

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[associate] +
    + + optional + , nil allowed + + +     		+ +

    determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

    + +

    Validations:

    +
      +
    • +

      Must be one of: new, always, never.

      +
      • +
    + + + +
    + options[lock] +
    + + optional + , nil allowed + + +     		+ +

    lock imported templates (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[default] +
    + + optional + , nil allowed + + +     		+ +

    makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/provisioning_templates/:id + +
    + Update a provisioning template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    not relevant for snippet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + provisioning_template[template_combinations_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of template combinations (hostgroup_id, environment_id)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the template

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + version +
    + + optional + + + +     		+ +

    template version

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/provisioning_templates/:id + +
    + Delete a provisioning template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/provisioning_templates/build_pxe_default + +
    + Update the default PXE menu on all configured TFTP servers +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/provisioning_templates/:id/clone + +
    + Clone a provision template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/provisioning_templates/:id/export + +
    + Export a provisioning template to ERB +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/build_pxe_default.html b/foreman/3.16/apidoc/v2/provisioning_templates/build_pxe_default.html new file mode 100644 index 00000000..fa90a9d0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/build_pxe_default.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/provisioning_templates/build_pxe_default +
    + Update the default PXE menu on all configured TFTP servers +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/clone.html b/foreman/3.16/apidoc/v2/provisioning_templates/clone.html new file mode 100644 index 00000000..fc2e87c3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/clone.html @@ -0,0 +1,219 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/provisioning_templates/:id/clone +
    + Clone a provision template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/create.html b/foreman/3.16/apidoc/v2/provisioning_templates/create.html new file mode 100644 index 00000000..da460fb1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/create.html @@ -0,0 +1,465 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/provisioning_templates +
    + Create a provisioning template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    not relevant for snippet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + provisioning_template[template_combinations_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of template combinations (hostgroup_id, environment_id)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the template

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/destroy.html b/foreman/3.16/apidoc/v2/provisioning_templates/destroy.html new file mode 100644 index 00000000..08cf96e5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/provisioning_templates/:id +
    + Delete a provisioning template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/export.html b/foreman/3.16/apidoc/v2/provisioning_templates/export.html new file mode 100644 index 00000000..ed451d4e --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/export.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/provisioning_templates/:id/export +
    + Export a provisioning template to ERB +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/import.html b/foreman/3.16/apidoc/v2/provisioning_templates/import.html new file mode 100644 index 00000000..2c6b41a2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/import.html @@ -0,0 +1,415 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/provisioning_templates/import +
    + Import a provisioning template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template] +
    + + optional + + + +     		+ +

    template contents including metadata

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + options +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + options[force] +
    + + optional + , nil allowed + + +     		+ +

    use if you want update locked templates

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[associate] +
    + + optional + , nil allowed + + +     		+ +

    determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

    + +

    Validations:

    +
      +
    • +

      Must be one of: new, always, never.

      +
      • +
    + + + +
    + options[lock] +
    + + optional + , nil allowed + + +     		+ +

    lock imported templates (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[default] +
    + + optional + , nil allowed + + +     		+ +

    makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/index.html b/foreman/3.16/apidoc/v2/provisioning_templates/index.html new file mode 100644 index 00000000..9fecc2c5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/index.html @@ -0,0 +1,385 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/provisioning_templates +
    + List provisioning templates +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/provisioning_templates +
    + List provisioning templates per operating system +

    +
    +
    +

    + GET /api/locations/:location_id/provisioning_templates +
    + List provisioning templates per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/provisioning_templates +
    + List provisioning templates per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    default_templatetrue, false
    hostgroupstring
    idinteger
    kindstring
    locationstring
    location_idinteger
    lockedtrue, false
    namestring
    operatingsystemstring
    organizationstring
    organization_idinteger
    snippettrue, false
    templatetext
    vendorstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/revision.html b/foreman/3.16/apidoc/v2/provisioning_templates/revision.html new file mode 100644 index 00000000..4878803e --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/revision.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/provisioning_templates/revision +
    + +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + version +
    + + optional + + + +     		+ +

    template version

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/show.html b/foreman/3.16/apidoc/v2/provisioning_templates/show.html new file mode 100644 index 00000000..5726a04d --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/provisioning_templates/:id +
    + Show provisioning template details +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/provisioning_templates/update.html b/foreman/3.16/apidoc/v2/provisioning_templates/update.html new file mode 100644 index 00000000..e863cfc1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/provisioning_templates/update.html @@ -0,0 +1,491 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/provisioning_templates/:id +
    + Update a provisioning template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + provisioning_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + provisioning_template[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + provisioning_template[template_kind_id] +
    + + optional + , nil allowed + + +     		+ +

    not relevant for snippet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + provisioning_template[template_combinations_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of template combinations (hostgroup_id, environment_id)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the template

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + provisioning_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + provisioning_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables.html b/foreman/3.16/apidoc/v2/ptables.html new file mode 100644 index 00000000..e2fe4000 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables.html @@ -0,0 +1,2373 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Ptables +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/ptables + +
    + List all partition tables +

    +

    + + GET /api/operatingsystems/:operatingsystem_id/ptables + +
    + List all partition tables for an operating system +

    +

    + + GET /api/locations/:location_id/ptables + +
    + List all partition tables per location +

    +

    + + GET /api/organizations/:organization_id/ptables + +
    + List all partition tables per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    defaulttrue, false
    familystring
    idinteger
    layouttext
    locationstring
    location_idinteger
    lockedtrue, false
    namestring
    organizationstring
    organization_idinteger
    snippettrue, false
    templatetext
    vendorstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/ptables/:id + +
    + Show a partition table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/ptables + +
    + Create a partition table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[layout] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[host_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host group IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/ptables/import + +
    + Import a partition table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[template] +
    + + optional + + + +     		+ +

    template contents including metadata

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + options +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + options[force] +
    + + optional + , nil allowed + + +     		+ +

    use if you want update locked templates

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[associate] +
    + + optional + , nil allowed + + +     		+ +

    determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

    + +

    Validations:

    +
      +
    • +

      Must be one of: new, always, never.

      +
      • +
    + + + +
    + options[lock] +
    + + optional + , nil allowed + + +     		+ +

    lock imported templates (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[default] +
    + + optional + , nil allowed + + +     		+ +

    makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + version +
    + + optional + + + +     		+ +

    template version

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/ptables/:id + +
    + Update a partition table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[layout] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[host_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host group IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/ptables/:id + +
    + Delete a partition table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/ptables/:id/clone + +
    + Clone a template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/ptables/:id/export + +
    + Export a partition template to ERB +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/clone.html b/foreman/3.16/apidoc/v2/ptables/clone.html new file mode 100644 index 00000000..c18ca803 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/clone.html @@ -0,0 +1,219 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/ptables/:id/clone +
    + Clone a template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/create.html b/foreman/3.16/apidoc/v2/ptables/create.html new file mode 100644 index 00000000..a0520987 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/create.html @@ -0,0 +1,489 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/ptables +
    + Create a partition table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[layout] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[host_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host group IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/destroy.html b/foreman/3.16/apidoc/v2/ptables/destroy.html new file mode 100644 index 00000000..f2cf3265 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/ptables/:id +
    + Delete a partition table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/export.html b/foreman/3.16/apidoc/v2/ptables/export.html new file mode 100644 index 00000000..1cfb4630 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/export.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/ptables/:id/export +
    + Export a partition template to ERB +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/import.html b/foreman/3.16/apidoc/v2/ptables/import.html new file mode 100644 index 00000000..6bb0f64e --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/import.html @@ -0,0 +1,415 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/ptables/import +
    + Import a partition table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[template] +
    + + optional + + + +     		+ +

    template contents including metadata

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + options +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + options[force] +
    + + optional + , nil allowed + + +     		+ +

    use if you want update locked templates

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[associate] +
    + + optional + , nil allowed + + +     		+ +

    determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

    + +

    Validations:

    +
      +
    • +

      Must be one of: new, always, never.

      +
      • +
    + + + +
    + options[lock] +
    + + optional + , nil allowed + + +     		+ +

    lock imported templates (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[default] +
    + + optional + , nil allowed + + +     		+ +

    makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/index.html b/foreman/3.16/apidoc/v2/ptables/index.html new file mode 100644 index 00000000..2ba369ab --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/index.html @@ -0,0 +1,380 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/ptables +
    + List all partition tables +

    +
    +
    +

    + GET /api/operatingsystems/:operatingsystem_id/ptables +
    + List all partition tables for an operating system +

    +
    +
    +

    + GET /api/locations/:location_id/ptables +
    + List all partition tables per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/ptables +
    + List all partition tables per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of operating system

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    defaulttrue, false
    familystring
    idinteger
    layouttext
    locationstring
    location_idinteger
    lockedtrue, false
    namestring
    organizationstring
    organization_idinteger
    snippettrue, false
    templatetext
    vendorstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/revision.html b/foreman/3.16/apidoc/v2/ptables/revision.html new file mode 100644 index 00000000..e9717ee1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/revision.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/ptables/revision +
    + +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + version +
    + + optional + + + +     		+ +

    template version

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/show.html b/foreman/3.16/apidoc/v2/ptables/show.html new file mode 100644 index 00000000..189e46c5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/ptables/:id +
    + Show a partition table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ptables/update.html b/foreman/3.16/apidoc/v2/ptables/update.html new file mode 100644 index 00000000..1a002b2d --- /dev/null +++ b/foreman/3.16/apidoc/v2/ptables/update.html @@ -0,0 +1,515 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/ptables/:id +
    + Update a partition table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ptable[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[layout] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + ptable[os_family] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ptable[operatingsystem_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of operating system IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[host_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[hostgroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Array of host group IDs to associate with the partition table

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + ptable[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/realms.html b/foreman/3.16/apidoc/v2/realms.html new file mode 100644 index 00000000..c3aaa93a --- /dev/null +++ b/foreman/3.16/apidoc/v2/realms.html @@ -0,0 +1,1123 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Realms +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/realms + +
    + List of realms +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    typestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/realms/:id + +
    + Show a realm +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Numerical ID or realm name

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/realms + +
    + Create a realm +

    +
    + + +
    + +

    The name field is used for the name of the realm.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + realm +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + realm[name] +
    + + required + + + +     		+ +

    The realm name, e.g. EXAMPLE.COM

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[realm_proxy_id] +
    + + required + , nil allowed + + +     		+ +

    Proxy ID to use within this realm

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + realm[realm_type] +
    + + required + + + +     		+ +

    Realm type, e.g. FreeIPA or Active Directory

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + realm[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/realms/:id + +
    + Update a realm +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + realm +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + realm[name] +
    + + optional + + + +     		+ +

    The realm name, e.g. EXAMPLE.COM

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[realm_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Proxy ID to use within this realm

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + realm[realm_type] +
    + + optional + + + +     		+ +

    Realm type, e.g. FreeIPA or Active Directory

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + realm[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/realms/:id + +
    + Delete a realm +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/realms/create.html b/foreman/3.16/apidoc/v2/realms/create.html new file mode 100644 index 00000000..3b7ef994 --- /dev/null +++ b/foreman/3.16/apidoc/v2/realms/create.html @@ -0,0 +1,307 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/realms +
    + Create a realm +

    +
    + +
    + + +

    The name field is used for the name of the realm.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + realm +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + realm[name] +
    + + required + + + +     		+ +

    The realm name, e.g. EXAMPLE.COM

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[realm_proxy_id] +
    + + required + , nil allowed + + +     		+ +

    Proxy ID to use within this realm

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + realm[realm_type] +
    + + required + + + +     		+ +

    Realm type, e.g. FreeIPA or Active Directory

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + realm[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/realms/destroy.html b/foreman/3.16/apidoc/v2/realms/destroy.html new file mode 100644 index 00000000..c20bb5c6 --- /dev/null +++ b/foreman/3.16/apidoc/v2/realms/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/realms/:id +
    + Delete a realm +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/realms/index.html b/foreman/3.16/apidoc/v2/realms/index.html new file mode 100644 index 00000000..d4b8c881 --- /dev/null +++ b/foreman/3.16/apidoc/v2/realms/index.html @@ -0,0 +1,301 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/realms +
    + List of realms +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    typestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/realms/show.html b/foreman/3.16/apidoc/v2/realms/show.html new file mode 100644 index 00000000..33200807 --- /dev/null +++ b/foreman/3.16/apidoc/v2/realms/show.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/realms/:id +
    + Show a realm +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Numerical ID or realm name

    + +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/realms/update.html b/foreman/3.16/apidoc/v2/realms/update.html new file mode 100644 index 00000000..8e68a98a --- /dev/null +++ b/foreman/3.16/apidoc/v2/realms/update.html @@ -0,0 +1,331 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/realms/:id +
    + Update a realm +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + realm +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + realm[name] +
    + + optional + + + +     		+ +

    The realm name, e.g. EXAMPLE.COM

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[realm_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    Proxy ID to use within this realm

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + realm[realm_type] +
    + + optional + + + +     		+ +

    Realm type, e.g. FreeIPA or Active Directory

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + realm[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + realm[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration.html b/foreman/3.16/apidoc/v2/registration.html new file mode 100644 index 00000000..9fd073ea --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration.html @@ -0,0 +1,2006 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Registration +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/register + +
    + Render Global registration template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + organization_id +
    + + optional + + + +     		+ +

    ID of the Organization to register the host in. Takes precedence over the `organization` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + organization +
    + + optional + + + +     		+ +

    Title of the Organization to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of the Location to register the host in. Takes precedence over the `location` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location +
    + + optional + + + +     		+ +

    Title of the Location to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of the Host group to register the host in. Takes precedence over the `hostgroup` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup +
    + + optional + + + +     		+ +

    Title of the Host group to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of the Operating System to register the host in. Takes precedence over the `operatingsystem` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + operatingsystem +
    + + optional + + + +     		+ +

    Title of the Operating System to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + setup_insights +
    + + optional + + + +     		+ +

    Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + setup_remote_execution +
    + + optional + + + +     		+ +

    Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + packages +
    + + optional + + + +     		+ +

    Packages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + update_packages +
    + + optional + + + +     		+ +

    Update all packages on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + repo + DEPRECATED +
    + + optional + + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + repo_gpg_key_url + DEPRECATED +
    + + optional + + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + repo_data +
    + + optional + + + +     		+ +

    Array with repository URL and corresponding GPG key URL

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + repo_data[repo] +
    + + optional + + + +     		+ +

    Repository URL / details, for example, for Debian OS family: 'deb deb.example.com/ buster 1.0', for Red Hat OS family: 'yum.theforeman.org/client/latest/el8/x86_64/'

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + repo_data[repo_gpg_key_url] +
    + + optional + + + +     		+ +

    URL of the GPG key for the repository

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + download_utility +
    + + optional + + + +     		+ +

    The download utility to use during host registration

    + +

    Validations:

    +
      +
    • +

      Must be one of: curl, wget.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/register + +
    + Find or create a host and render the 'Host initial configuration' template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[location_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[organization_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address, not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address, not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[mac] +
    + + optional + , nil allowed + + +     		+ +

    required for managed host that is bare metal, not required if it's a virtual machine

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[model_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[host_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's parameters (array or indexed hash)

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[host_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + host[host_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[build] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[enabled] +
    + + optional + , nil allowed + + +     		+ +

    Include this host within Foreman reporting

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[managed] +
    + + optional + , nil allowed + + +     		+ +

    True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[comment] +
    + + optional + , nil allowed + + +     		+ +

    Additional information about this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's network interfaces

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[interfaces_attributes][mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + host[interfaces_attributes][name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + host[interfaces_attributes][virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + host[interfaces_attributes][bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + setup_insights +
    + + optional + + + +     		+ +

    Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + setup_remote_execution +
    + + optional + + + +     		+ +

    Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration/global.html b/foreman/3.16/apidoc/v2/registration/global.html new file mode 100644 index 00000000..0669b116 --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration/global.html @@ -0,0 +1,589 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/register +
    + Render Global registration template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + organization_id +
    + + optional + + + +     		+ +

    ID of the Organization to register the host in. Takes precedence over the `organization` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + organization +
    + + optional + + + +     		+ +

    Title of the Organization to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    ID of the Location to register the host in. Takes precedence over the `location` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + location +
    + + optional + + + +     		+ +

    Title of the Location to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of the Host group to register the host in. Takes precedence over the `hostgroup` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + hostgroup +
    + + optional + + + +     		+ +

    Title of the Host group to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + operatingsystem_id +
    + + optional + + + +     		+ +

    ID of the Operating System to register the host in. Takes precedence over the `operatingsystem` parameter

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + operatingsystem +
    + + optional + + + +     		+ +

    Title of the Operating System to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + setup_insights +
    + + optional + + + +     		+ +

    Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + setup_remote_execution +
    + + optional + + + +     		+ +

    Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + packages +
    + + optional + + + +     		+ +

    Packages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + update_packages +
    + + optional + + + +     		+ +

    Update all packages on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + repo + DEPRECATED +
    + + optional + + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + repo_gpg_key_url + DEPRECATED +
    + + optional + + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + repo_data +
    + + optional + + + +     		+ +

    Array with repository URL and corresponding GPG key URL

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + repo_data[repo] +
    + + optional + + + +     		+ +

    Repository URL / details, for example, for Debian OS family: 'deb deb.example.com/ buster 1.0', for Red Hat OS family: 'yum.theforeman.org/client/latest/el8/x86_64/'

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + repo_data[repo_gpg_key_url] +
    + + optional + + + +     		+ +

    URL of the GPG key for the repository

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + download_utility +
    + + optional + + + +     		+ +

    The download utility to use during host registration

    + +

    Validations:

    +
      +
    • +

      Must be one of: curl, wget.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration/host.html b/foreman/3.16/apidoc/v2/registration/host.html new file mode 100644 index 00000000..e9aae481 --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration/host.html @@ -0,0 +1,1439 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/register +
    + Find or create a host and render the 'Host initial configuration' template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + host[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[location_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[organization_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address, not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address, not required if using a subnet with DHCP proxy

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[mac] +
    + + optional + , nil allowed + + +     		+ +

    required for managed host that is bare metal, not required if it's a virtual machine

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[domain_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    required if host is managed and value is not inherited from host group

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[model_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[host_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's parameters (array or indexed hash)

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[host_parameters_attributes][name] +
    + + optional + + + +     		+ +

    Name of the parameter

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][value] +
    + + optional + + + +     		+ +

    Parameter value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[host_parameters_attributes][parameter_type] +
    + + optional + , nil allowed + + +     		+ +

    Type of value

    + +

    Validations:

    +
      +
    • +

      Must be one of: string, boolean, integer, real, array, hash, yaml, json.

      +
      • +
    + + + +
    + host[host_parameters_attributes][hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[build] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[enabled] +
    + + optional + , nil allowed + + +     		+ +

    Include this host within Foreman reporting

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[managed] +
    + + optional + , nil allowed + + +     		+ +

    True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[comment] +
    + + optional + , nil allowed + + +     		+ +

    Additional information about this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Host's network interfaces

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + host[interfaces_attributes][mac] +
    + + optional + , nil allowed + + +     		+ +

    MAC address of interface. Required for managed interfaces on bare metal.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip] +
    + + optional + , nil allowed + + +     		+ +

    IPv4 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][ip6] +
    + + optional + , nil allowed + + +     		+ +

    IPv6 address of interface

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][type] +
    + + optional + , nil allowed + + +     		+ +

    Interface type, e.g. bmc. Default is interface

    + +

    Validations:

    +
      +
    • +

      Must be one of: interface, bmc, bond, bridge, interface, bmc, bond, bridge, interface, bmc, bond, bridge.

      +
      • +
    + + + +
    + host[interfaces_attributes][name] +
    + + optional + , nil allowed + + +     		+ +

    Interface's DNS name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv4 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][subnet6_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman subnet ID of IPv6 interface

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][domain_id] +
    + + optional + , nil allowed + + +     		+ +

    Foreman domain ID of interface. Required for primary interfaces on managed hosts.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + host[interfaces_attributes][identifier] +
    + + optional + , nil allowed + + +     		+ +

    Device identifier, e.g. eth0 or eth1.1

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][managed] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][primary] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][provision] +
    + + optional + , nil allowed + + +     		+ +

    Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][username] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][password] +
    + + optional + , nil allowed + + +     		+ +

    Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][provider] +
    + + optional + , nil allowed + + +     		+ +

    Interface provider, e.g. IPMI. Only for BMC interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPMI, Redfish, SSH.

      +
      • +
    + + + +
    + host[interfaces_attributes][virtual] +
    + + optional + , nil allowed + + +     		+ +

    Alias or VLAN device

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + host[interfaces_attributes][tag] +
    + + optional + , nil allowed + + +     		+ +

    VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU, this attribute has precedence over the subnet MTU.

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_to] +
    + + optional + , nil allowed + + +     		+ +

    Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][mode] +
    + + optional + , nil allowed + + +     		+ +

    Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

      +
      • +
    + + + +
    + host[interfaces_attributes][attached_devices] +
    + + optional + , nil allowed + + +     		+ +

    Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + host[interfaces_attributes][bond_options] +
    + + optional + , nil allowed + + +     		+ +

    Space separated options, e.g. miimon=100. Only for bond interfaces.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + host[interfaces_attributes][compute_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Additional compute resource specific attributes for the interface.

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + setup_insights +
    + + optional + + + +     		+ +

    Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + setup_remote_execution +
    + + optional + + + +     		+ +

    Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration_commands.html b/foreman/3.16/apidoc/v2/registration_commands.html new file mode 100644 index 00000000..5d7fd9e0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration_commands.html @@ -0,0 +1,663 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Registration_commands + +
      • + +
    + +
    +

    + Registration_commands +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + POST /api/registration_commands + +
    + Generate global registration command +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + registration_command +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + registration_command[organization_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Organization to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[location_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Location to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Host group to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Operating System to register the host in. Operating system must have a `host_init_config` template assigned

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[smart_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Smart Proxy. This Proxy must have enabled both the 'Templates' and 'Registration' features

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[setup_insights] +
    + + optional + , nil allowed + + +     		+ +

    Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[setup_remote_execution] +
    + + optional + , nil allowed + + +     		+ +

    Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[jwt_expiration] +
    + + optional + , nil allowed + + +     		+ +

    Expiration of the authorization token (in hours), 0 means 'unlimited'.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[insecure] +
    + + optional + , nil allowed + + +     		+ +

    Enable insecure argument for the initial curl/wget

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[packages] +
    + + optional + , nil allowed + + +     		+ +

    Packages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[update_packages] +
    + + optional + , nil allowed + + +     		+ +

    Update all packages on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[repo] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[repo_gpg_key_url] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[repo_data] +
    + + optional + , nil allowed + + +     		+ +

    Array with repository URL and corresponding GPG key URL

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + registration_command[repo_data][repo] +
    + + optional + , nil allowed + + +     		+ +

    Repository URL / details, for example, for Debian OS family: 'deb deb.example.com/ buster 1.0', for Red Hat and SUSE OS family: 'yum.theforeman.org/client/latest/el8/x86_64/'

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[repo_data][repo_gpg_key_url] +
    + + optional + , nil allowed + + +     		+ +

    URL of the GPG key for the repository

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[download_utility] +
    + + optional + , nil allowed + + +     		+ +

    The download utility to use during host registration

    + +

    Validations:

    +
      +
    • +

      Must be one of: curl, wget.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration_commands/create.html b/foreman/3.16/apidoc/v2/registration_commands/create.html new file mode 100644 index 00000000..aaa5ddcf --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration_commands/create.html @@ -0,0 +1,643 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/registration_commands +
    + Generate global registration command +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + registration_command +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + registration_command[organization_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Organization to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[location_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Location to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Host group to register the host in

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[operatingsystem_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Operating System to register the host in. Operating system must have a `host_init_config` template assigned

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[smart_proxy_id] +
    + + optional + , nil allowed + + +     		+ +

    ID of the Smart Proxy. This Proxy must have enabled both the 'Templates' and 'Registration' features

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[setup_insights] +
    + + optional + , nil allowed + + +     		+ +

    Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[setup_remote_execution] +
    + + optional + , nil allowed + + +     		+ +

    Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[jwt_expiration] +
    + + optional + , nil allowed + + +     		+ +

    Expiration of the authorization token (in hours), 0 means 'unlimited'.

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + registration_command[insecure] +
    + + optional + , nil allowed + + +     		+ +

    Enable insecure argument for the initial curl/wget

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[packages] +
    + + optional + , nil allowed + + +     		+ +

    Packages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[update_packages] +
    + + optional + , nil allowed + + +     		+ +

    Update all packages on the host

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + registration_command[repo] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[repo_gpg_key_url] + DEPRECATED +
    + + optional + , nil allowed + + +     		+ +

    DEPRECATED, use the `repo_data` param instead.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[repo_data] +
    + + optional + , nil allowed + + +     		+ +

    Array with repository URL and corresponding GPG key URL

    + +

    Validations:

    +
      +
    • +

      Must be an Array of nested elements

      +
      • +
    + + + +
    + registration_command[repo_data][repo] +
    + + optional + , nil allowed + + +     		+ +

    Repository URL / details, for example, for Debian OS family: 'deb deb.example.com/ buster 1.0', for Red Hat and SUSE OS family: 'yum.theforeman.org/client/latest/el8/x86_64/'

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[repo_data][repo_gpg_key_url] +
    + + optional + , nil allowed + + +     		+ +

    URL of the GPG key for the repository

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + registration_command[download_utility] +
    + + optional + , nil allowed + + +     		+ +

    The download utility to use during host registration

    + +

    Validations:

    +
      +
    • +

      Must be one of: curl, wget.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration_tokens.html b/foreman/3.16/apidoc/v2/registration_tokens.html new file mode 100644 index 00000000..84dd78d0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration_tokens.html @@ -0,0 +1,316 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Registration_tokens + +
      • + +
    + +
    +

    + Registration_tokens +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + DELETE /api/users/:user_id/registration_tokens + +
    + Invalidate all registration tokens for a specific user +

    +
    + + +
    + +

    The user you specify will no longer be able to register hosts by using their JWTs.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/registration_tokens + +
    + Invalidate all registration tokens for multiple users +

    +
    + + +
    + +

    The users you specify will no longer be able to register hosts by using their JWTs.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + required + + + +     		+ +

    Search query that selects users for which registration tokens will be invalidated. Search query example: id ^ (2, 4, 6)

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt.html b/foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt.html new file mode 100644 index 00000000..dc46491c --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt.html @@ -0,0 +1,169 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/users/:user_id/registration_tokens +
    + Invalidate all registration tokens for a specific user +

    +
    + +
    + + +

    The user you specify will no longer be able to register hosts by using their JWTs.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt_tokens.html b/foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt_tokens.html new file mode 100644 index 00000000..9418555a --- /dev/null +++ b/foreman/3.16/apidoc/v2/registration_tokens/invalidate_jwt_tokens.html @@ -0,0 +1,169 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/registration_tokens +
    + Invalidate all registration tokens for multiple users +

    +
    + +
    + + +

    The users you specify will no longer be able to register hosts by using their JWTs.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + required + + + +     		+ +

    Search query that selects users for which registration tokens will be invalidated. Search query example: id ^ (2, 4, 6)

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates.html b/foreman/3.16/apidoc/v2/report_templates.html new file mode 100644 index 00000000..e8d68d39 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates.html @@ -0,0 +1,2789 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Report_templates + +
      • + +
    + +
    +

    + Report_templates +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/report_templates + +
    + List all report templates +

    +

    + + GET /api/locations/:location_id/report_templates + +
    + List all report templates per location +

    +

    + + GET /api/organizations/:organization_id/report_templates + +
    + List all report templates per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    defaulttrue, false
    idinteger
    locationstring
    location_idinteger
    lockedtrue, false
    namestring
    organizationstring
    organization_idinteger
    snippettrue, false
    templatetext
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/report_templates/:id + +
    + Show a report template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/report_templates + +
    + Create a report template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[template] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[default] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is added automatically to new organizations and locations

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + report_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/report_templates/import + +
    + Import a report template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[template] +
    + + optional + + + +     		+ +

    template contents including metadata

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + report_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + options +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + options[force] +
    + + optional + , nil allowed + + +     		+ +

    use if you want update locked templates

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[associate] +
    + + optional + , nil allowed + + +     		+ +

    determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

    + +

    Validations:

    +
      +
    • +

      Must be one of: new, always, never.

      +
      • +
    + + + +
    + options[lock] +
    + + optional + , nil allowed + + +     		+ +

    lock imported templates (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[default] +
    + + optional + , nil allowed + + +     		+ +

    makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + version +
    + + optional + + + +     		+ +

    template version

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/report_templates/:id + +
    + Update a report template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[template] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[default] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is added automatically to new organizations and locations

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + report_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/report_templates/:id + +
    + Delete a report template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/report_templates/:id/clone + +
    + Clone a template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/report_templates/:id/export + +
    + Export a report template to ERB +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/report_templates/:id/generate + +
    + Generate report from a template +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + input_values +
    + + optional + + + +     		+ +

    Hash of input values where key is the name of input, value is the value for this input

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + gzip +
    + + optional + + + +     		+ +

    Compress the report uzing gzip

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_format +
    + + optional + + + +     		+ +

    Report format, defaults to 'csv'

    + +

    Validations:

    +
      +
    • +

      Must be one of: csv, json, yaml, html.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/report_templates/:id/schedule_report + +
    + Schedule generating of a report +

    +
    + + +
    + +

    The reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see report_data).

    + + + + +

    Examples

    + 
    POST /api/report_templates/:id/schedule_report/
+200
+{
+  "job_id": UNIQUE-REPORT-GENERATING-JOB-UUID
+  "data_url": "/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID"
+}
+
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + input_values +
    + + optional + + + +     		+ +

    Hash of input values where key is the name of input, value is the value for this input

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + gzip +
    + + optional + + + +     		+ +

    Compress the report using gzip

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + mail_to +
    + + optional + + + +     		+ +

    If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + generate_at +
    + + optional + + + +     		+ +

    UTC time to generate report at

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_format +
    + + optional + + + +     		+ +

    Report format, defaults to 'csv'

    + +

    Validations:

    +
      +
    • +

      Must be one of: csv, json, yaml, html.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/report_templates/:id/report_data/:job_id + +
    + Downloads a generated report +

    +
    + + +
    + +

    Returns the report data as a raw response. In case the report hasn't been generated yet, it will return an empty response with http status 204 - NoContent.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + job_id +
    + + required + + + +     		+ +

    ID assigned to generating job by the schedule command

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/clone.html b/foreman/3.16/apidoc/v2/report_templates/clone.html new file mode 100644 index 00000000..d15e2c5e --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/clone.html @@ -0,0 +1,219 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/report_templates/:id/clone +
    + Clone a template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + required + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/create.html b/foreman/3.16/apidoc/v2/report_templates/create.html new file mode 100644 index 00000000..d957cc35 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/create.html @@ -0,0 +1,407 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/report_templates +
    + Create a report template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[template] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[default] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is added automatically to new organizations and locations

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + report_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/destroy.html b/foreman/3.16/apidoc/v2/report_templates/destroy.html new file mode 100644 index 00000000..fda39ebf --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/report_templates/:id +
    + Delete a report template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/export.html b/foreman/3.16/apidoc/v2/report_templates/export.html new file mode 100644 index 00000000..5ce6e755 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/export.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/report_templates/:id/export +
    + Export a report template to ERB +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/generate.html b/foreman/3.16/apidoc/v2/report_templates/generate.html new file mode 100644 index 00000000..7eea40d4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/generate.html @@ -0,0 +1,249 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/report_templates/:id/generate +
    + Generate report from a template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + input_values +
    + + optional + + + +     		+ +

    Hash of input values where key is the name of input, value is the value for this input

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + gzip +
    + + optional + + + +     		+ +

    Compress the report uzing gzip

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_format +
    + + optional + + + +     		+ +

    Report format, defaults to 'csv'

    + +

    Validations:

    +
      +
    • +

      Must be one of: csv, json, yaml, html.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/import.html b/foreman/3.16/apidoc/v2/report_templates/import.html new file mode 100644 index 00000000..ac249b98 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/import.html @@ -0,0 +1,415 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/report_templates/import +
    + Import a report template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + optional + + + +     		+ +

    template name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[template] +
    + + optional + + + +     		+ +

    template contents including metadata

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + report_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + options +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + options[force] +
    + + optional + , nil allowed + + +     		+ +

    use if you want update locked templates

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[associate] +
    + + optional + , nil allowed + + +     		+ +

    determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

    + +

    Validations:

    +
      +
    • +

      Must be one of: new, always, never.

      +
      • +
    + + + +
    + options[lock] +
    + + optional + , nil allowed + + +     		+ +

    lock imported templates (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + options[default] +
    + + optional + , nil allowed + + +     		+ +

    makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/index.html b/foreman/3.16/apidoc/v2/report_templates/index.html new file mode 100644 index 00000000..0731c400 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/index.html @@ -0,0 +1,330 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/report_templates +
    + List all report templates +

    +
    +
    +

    + GET /api/locations/:location_id/report_templates +
    + List all report templates per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/report_templates +
    + List all report templates per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    defaulttrue, false
    idinteger
    locationstring
    location_idinteger
    lockedtrue, false
    namestring
    organizationstring
    organization_idinteger
    snippettrue, false
    templatetext
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/report_data.html b/foreman/3.16/apidoc/v2/report_templates/report_data.html new file mode 100644 index 00000000..2bb70cc8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/report_data.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/report_templates/:id/report_data/:job_id +
    + Downloads a generated report +

    +
    + +
    + + +

    Returns the report data as a raw response. In case the report hasn't been generated yet, it will return an empty response with http status 204 - NoContent.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + job_id +
    + + required + + + +     		+ +

    ID assigned to generating job by the schedule command

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/revision.html b/foreman/3.16/apidoc/v2/report_templates/revision.html new file mode 100644 index 00000000..43b96503 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/revision.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/report_templates/revision +
    + +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + version +
    + + optional + + + +     		+ +

    template version

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/schedule_report.html b/foreman/3.16/apidoc/v2/report_templates/schedule_report.html new file mode 100644 index 00000000..436cbcc5 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/schedule_report.html @@ -0,0 +1,315 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/report_templates/:id/schedule_report +
    + Schedule generating of a report +

    +
    + +
    + + +

    The reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see report_data).

    + + + + +

    Examples

    + 
    POST /api/report_templates/:id/schedule_report/
+200
+{
+  "job_id": UNIQUE-REPORT-GENERATING-JOB-UUID
+  "data_url": "/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID"
+}
+
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + input_values +
    + + optional + + + +     		+ +

    Hash of input values where key is the name of input, value is the value for this input

    + +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + gzip +
    + + optional + + + +     		+ +

    Compress the report using gzip

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + mail_to +
    + + optional + + + +     		+ +

    If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses.

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + generate_at +
    + + optional + + + +     		+ +

    UTC time to generate report at

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_format +
    + + optional + + + +     		+ +

    Report format, defaults to 'csv'

    + +

    Validations:

    +
      +
    • +

      Must be one of: csv, json, yaml, html.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/show.html b/foreman/3.16/apidoc/v2/report_templates/show.html new file mode 100644 index 00000000..a3c78da2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/report_templates/:id +
    + Show a report template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/report_templates/update.html b/foreman/3.16/apidoc/v2/report_templates/update.html new file mode 100644 index 00000000..4ee6c32a --- /dev/null +++ b/foreman/3.16/apidoc/v2/report_templates/update.html @@ -0,0 +1,433 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/report_templates/:id +
    + Update a report template +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + report_template[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[template] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[snippet] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[audit_comment] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + report_template[locked] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is locked for editing

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[default] +
    + + optional + , nil allowed + + +     		+ +

    Whether or not the template is added automatically to new organizations and locations

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + report_template[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + report_template[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles.html b/foreman/3.16/apidoc/v2/roles.html new file mode 100644 index 00000000..b92d1f98 --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles.html @@ -0,0 +1,1339 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Roles +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/roles + +
    + List all roles +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    builtintrue, false
    descriptiontext
    idinteger
    lockedtrue, false
    namestring
    permissionstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/roles/:id + +
    + Show a role +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + description +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/roles + +
    + Create a role +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + role +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + role[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[description] +
    + + optional + , nil allowed + + +     		+ +

    Role description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + role[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/roles/:id + +
    + Update a role +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + role[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[description] +
    + + optional + , nil allowed + + +     		+ +

    Role description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + role[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/roles/:id + +
    + Delete a role +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/roles/:id/clone + +
    + Clone a role +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + role[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[description] +
    + + optional + , nil allowed + + +     		+ +

    Role description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + role[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles/clone.html b/foreman/3.16/apidoc/v2/roles/clone.html new file mode 100644 index 00000000..ff2d8ec4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles/clone.html @@ -0,0 +1,301 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/roles/:id/clone +
    + Clone a role +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + role[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[description] +
    + + optional + , nil allowed + + +     		+ +

    Role description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + role[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles/create.html b/foreman/3.16/apidoc/v2/roles/create.html new file mode 100644 index 00000000..5e9ecaa6 --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles/create.html @@ -0,0 +1,275 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/roles +
    + Create a role +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + role +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + role[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[description] +
    + + optional + , nil allowed + + +     		+ +

    Role description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + role[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles/destroy.html b/foreman/3.16/apidoc/v2/roles/destroy.html new file mode 100644 index 00000000..24c85e9d --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/roles/:id +
    + Delete a role +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles/index.html b/foreman/3.16/apidoc/v2/roles/index.html new file mode 100644 index 00000000..336d1b13 --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles/index.html @@ -0,0 +1,296 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/roles +
    + List all roles +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    builtintrue, false
    descriptiontext
    idinteger
    lockedtrue, false
    namestring
    permissionstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles/show.html b/foreman/3.16/apidoc/v2/roles/show.html new file mode 100644 index 00000000..aeaaa291 --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles/show.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/roles/:id +
    + Show a role +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + description +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/roles/update.html b/foreman/3.16/apidoc/v2/roles/update.html new file mode 100644 index 00000000..d9acb384 --- /dev/null +++ b/foreman/3.16/apidoc/v2/roles/update.html @@ -0,0 +1,301 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/roles/:id +
    + Update a role +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + role[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[description] +
    + + optional + , nil allowed + + +     		+ +

    Role description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + role[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/settings.html b/foreman/3.16/apidoc/v2/settings.html new file mode 100644 index 00000000..b6165d88 --- /dev/null +++ b/foreman/3.16/apidoc/v2/settings.html @@ -0,0 +1,476 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Settings +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/settings + +
    + List all settings +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    description
    idinteger
    namestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/settings/:id + +
    + Show a setting +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/settings/:id + +
    + Update a setting +

    +
    + + +
    + + + + +

    Examples

    + 
    PUT /api/settings/http_proxy_except_list
+{
+  "id": "http_proxy_except_list",
+  "name": "http_proxy_except_list",
+  "category": "general",
+  "description": "Set hostnames to which requests are not to be proxied. Requests to the local host are excluded by default.",
+  "settingsType": "array",
+  "default": [],
+  "readonly": false,
+  "fullName": "HTTP(S) proxy except hosts",
+  "configFile": null,
+  "selectValues": null,
+  "value": [
+    "testArr",
+    "testArr2"
+  ],
+  "encrypted": false
+}
+200
+{
+  "description": "Set hostnames to which requests are not to be proxied. Requests to the local host are excluded by default.",
+  "settings_type": "array",
+  "default": [],
+  "updated_at": "2025-08-20 10:30:31 UTC",
+  "id": "http_proxy_except_list",
+  "name": "http_proxy_except_list",
+  "full_name": "HTTP(S) proxy except hosts",
+  "value": [
+    "testArr",
+    "testArr2"
+  ],
+  "category": "general",
+  "category_name": "General",
+  "readonly": false,
+  "config_file": null,
+  "encrypted": false,
+  "select_values": null
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + setting +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + setting[value] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/settings/index.html b/foreman/3.16/apidoc/v2/settings/index.html new file mode 100644 index 00000000..1408b062 --- /dev/null +++ b/foreman/3.16/apidoc/v2/settings/index.html @@ -0,0 +1,227 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/settings +
    + List all settings +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    description
    idinteger
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/settings/show.html b/foreman/3.16/apidoc/v2/settings/show.html new file mode 100644 index 00000000..ef4e572e --- /dev/null +++ b/foreman/3.16/apidoc/v2/settings/show.html @@ -0,0 +1,111 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/settings/:id +
    + Show a setting +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/settings/update.html b/foreman/3.16/apidoc/v2/settings/update.html new file mode 100644 index 00000000..1c48cee0 --- /dev/null +++ b/foreman/3.16/apidoc/v2/settings/update.html @@ -0,0 +1,202 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/settings/:id +
    + Update a setting +

    +
    + +
    + + + + + +

    Examples

    + 
    PUT /api/settings/http_proxy_except_list
+{
+  "id": "http_proxy_except_list",
+  "name": "http_proxy_except_list",
+  "category": "general",
+  "description": "Set hostnames to which requests are not to be proxied. Requests to the local host are excluded by default.",
+  "settingsType": "array",
+  "default": [],
+  "readonly": false,
+  "fullName": "HTTP(S) proxy except hosts",
+  "configFile": null,
+  "selectValues": null,
+  "value": [
+    "testArr",
+    "testArr2"
+  ],
+  "encrypted": false
+}
+200
+{
+  "description": "Set hostnames to which requests are not to be proxied. Requests to the local host are excluded by default.",
+  "settings_type": "array",
+  "default": [],
+  "updated_at": "2025-08-20 10:30:31 UTC",
+  "id": "http_proxy_except_list",
+  "name": "http_proxy_except_list",
+  "full_name": "HTTP(S) proxy except hosts",
+  "value": [
+    "testArr",
+    "testArr2"
+  ],
+  "category": "general",
+  "category_name": "General",
+  "readonly": false,
+  "config_file": null,
+  "encrypted": false,
+  "select_values": null
+}
    + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + setting +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + setting[value] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies.html b/foreman/3.16/apidoc/v2/smart_proxies.html new file mode 100644 index 00000000..f9b65a4b --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies.html @@ -0,0 +1,1390 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Smart_proxies +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/smart_proxies + +
    + List all smart proxies +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + include_status +
    + + optional + + + +     		+ +

    Flag to indicate whether to include status or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    featurestring
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    urlstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/smart_proxies/:id + +
    + Show a smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + include_status +
    + + optional + + + +     		+ +

    Flag to indicate whether to include status or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + include_version +
    + + optional + + + +     		+ +

    Flag to indicate whether to include version or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/smart_proxies + +
    + Create a smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + smart_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + smart_proxy[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[url] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + smart_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/smart_proxies/:id + +
    + Update a smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + smart_proxy[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[url] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + smart_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/smart_proxies/:id + +
    + Delete a smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/smart_proxies/:id/refresh + +
    + Refresh smart proxy features +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/smart_proxies/:id/import_subnets + +
    + Import subnets from Smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/create.html b/foreman/3.16/apidoc/v2/smart_proxies/create.html new file mode 100644 index 00000000..f9d8f4e3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/create.html @@ -0,0 +1,273 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/smart_proxies +
    + Create a smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + smart_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + smart_proxy[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[url] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + smart_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/destroy.html b/foreman/3.16/apidoc/v2/smart_proxies/destroy.html new file mode 100644 index 00000000..530127d8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/smart_proxies/:id +
    + Delete a smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/import_subnets.html b/foreman/3.16/apidoc/v2/smart_proxies/import_subnets.html new file mode 100644 index 00000000..8c52378b --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/import_subnets.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/smart_proxies/:id/import_subnets +
    + Import subnets from Smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/index.html b/foreman/3.16/apidoc/v2/smart_proxies/index.html new file mode 100644 index 00000000..31011430 --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/index.html @@ -0,0 +1,334 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/smart_proxies +
    + List all smart proxies +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + include_status +
    + + optional + + + +     		+ +

    Flag to indicate whether to include status or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    featurestring
    idinteger
    locationstring
    location_idinteger
    namestring
    organizationstring
    organization_idinteger
    urlstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/refresh.html b/foreman/3.16/apidoc/v2/smart_proxies/refresh.html new file mode 100644 index 00000000..2f74ecac --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/refresh.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/smart_proxies/:id/refresh +
    + Refresh smart proxy features +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/show.html b/foreman/3.16/apidoc/v2/smart_proxies/show.html new file mode 100644 index 00000000..ac1ff947 --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/show.html @@ -0,0 +1,221 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/smart_proxies/:id +
    + Show a smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + include_status +
    + + optional + + + +     		+ +

    Flag to indicate whether to include status or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + include_version +
    + + optional + + + +     		+ +

    Flag to indicate whether to include version or not

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxies/update.html b/foreman/3.16/apidoc/v2/smart_proxies/update.html new file mode 100644 index 00000000..37120d95 --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxies/update.html @@ -0,0 +1,299 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/smart_proxies/:id +
    + Update a smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + smart_proxy[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[url] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + smart_proxy[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + smart_proxy[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxy_hosts.html b/foreman/3.16/apidoc/v2/smart_proxy_hosts.html new file mode 100644 index 00000000..873aa3ed --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxy_hosts.html @@ -0,0 +1,405 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Smart_proxy_hosts + +
      • + +
    + +
    +

    + Smart_proxy_hosts +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + PUT /api/smart_proxies/:smart_proxy_id/hosts/:host_id + +
    + Assign a host to the smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + smart_proxy_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + host_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/smart_proxies/:smart_proxy_id/hosts + +
    + Get hosts forming the smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/smart_proxies/:smart_proxy_id/hosts/:host_id + +
    + Unassign a given host from the smart proxy +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxy_hosts/destroy.html b/foreman/3.16/apidoc/v2/smart_proxy_hosts/destroy.html new file mode 100644 index 00000000..e2ced4e1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxy_hosts/destroy.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/smart_proxies/:smart_proxy_id/hosts/:host_id +
    + Unassign a given host from the smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxy_hosts/index.html b/foreman/3.16/apidoc/v2/smart_proxy_hosts/index.html new file mode 100644 index 00000000..49d2965b --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxy_hosts/index.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/smart_proxies/:smart_proxy_id/hosts +
    + Get hosts forming the smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/smart_proxy_hosts/update.html b/foreman/3.16/apidoc/v2/smart_proxy_hosts/update.html new file mode 100644 index 00000000..52de25be --- /dev/null +++ b/foreman/3.16/apidoc/v2/smart_proxy_hosts/update.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/smart_proxies/:smart_proxy_id/hosts/:host_id +
    + Assign a host to the smart proxy +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + smart_proxy_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + host_id +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ssh_keys.html b/foreman/3.16/apidoc/v2/ssh_keys.html new file mode 100644 index 00000000..cf65e9ae --- /dev/null +++ b/foreman/3.16/apidoc/v2/ssh_keys.html @@ -0,0 +1,836 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Ssh_keys +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/users/:user_id/ssh_keys + +
    + List all SSH keys for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    user_idinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/users/:user_id/ssh_keys/:id + +
    + Show an SSH key from a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/users/:user_id/ssh_keys + +
    + Add an SSH key for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ssh_key +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ssh_key[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ssh_key[key] +
    + + required + + + +     		+ +

    Public SSH key

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/users/:user_id/ssh_keys/:id + +
    + Delete an SSH key for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ssh_keys/create.html b/foreman/3.16/apidoc/v2/ssh_keys/create.html new file mode 100644 index 00000000..42d1e0ae --- /dev/null +++ b/foreman/3.16/apidoc/v2/ssh_keys/create.html @@ -0,0 +1,247 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/users/:user_id/ssh_keys +
    + Add an SSH key for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ssh_key +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + ssh_key[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + ssh_key[key] +
    + + required + + + +     		+ +

    Public SSH key

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ssh_keys/destroy.html b/foreman/3.16/apidoc/v2/ssh_keys/destroy.html new file mode 100644 index 00000000..b309ece7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ssh_keys/destroy.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/users/:user_id/ssh_keys/:id +
    + Delete an SSH key for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ssh_keys/index.html b/foreman/3.16/apidoc/v2/ssh_keys/index.html new file mode 100644 index 00000000..0b32b1c7 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ssh_keys/index.html @@ -0,0 +1,309 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/ssh_keys +
    + List all SSH keys for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    user_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/ssh_keys/show.html b/foreman/3.16/apidoc/v2/ssh_keys/show.html new file mode 100644 index 00000000..c7e06f77 --- /dev/null +++ b/foreman/3.16/apidoc/v2/ssh_keys/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/ssh_keys/:id +
    + Show an SSH key from a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets.html b/foreman/3.16/apidoc/v2/subnets.html new file mode 100644 index 00000000..d6de0b09 --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets.html @@ -0,0 +1,2680 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Subnets +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/subnets + +
    + List of subnets +

    +

    + + GET /api/domains/:domain_id/subnets + +
    + List of subnets for a domain +

    +

    + + GET /api/locations/:location_id/subnets + +
    + List of subnets per location +

    +

    + + GET /api/organizations/:organization_id/subnets + +
    + List of subnets per organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    boot_modestring
    dns_primarystring
    dns_secondarystring
    domainstring
    gatewaystring
    idinteger
    ipamstring
    locationstring
    location_idinteger
    maskstring
    mtuinteger
    nametext
    networkstring
    nic_delayinteger
    organizationstring
    organization_idinteger
    paramsstring
    typestring
    vlanidinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/subnets/:id + +
    + Show a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/subnets + +
    + Create a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + subnet +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + subnet[name] +
    + + required + + + +     		+ +

    Subnet name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[description] +
    + + optional + , nil allowed + + +     		+ +

    Subnet description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[network_type] +
    + + optional + , nil allowed + + +     		+ +

    Type or protocol, IPv4 or IPv6, defaults to IPv4

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPv4, IPv6.

      +
      • +
    + + + +
    + subnet[network] +
    + + required + + + +     		+ +

    Subnet network

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[cidr] +
    + + optional + , nil allowed + + +     		+ +

    Network prefix in CIDR notation

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mask] +
    + + optional + , nil allowed + + +     		+ +

    Netmask for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[gateway] +
    + + optional + , nil allowed + + +     		+ +

    Subnet gateway

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_primary] +
    + + optional + , nil allowed + + +     		+ +

    Primary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_secondary] +
    + + optional + , nil allowed + + +     		+ +

    Secondary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[ipam] +
    + + optional + , nil allowed + + +     		+ +

    IP Address auto suggestion mode for this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.

      +
      • +
    + + + +
    + subnet[externalipam_group] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM group - only relevant when IPAM is set to external

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[from] +
    + + optional + , nil allowed + + +     		+ +

    Starting IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[to] +
    + + optional + , nil allowed + + +     		+ +

    Ending IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[vlanid] +
    + + optional + , nil allowed + + +     		+ +

    VLAN ID for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + subnet[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domains in which this subnet is part

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[dhcp_id] +
    + + optional + , nil allowed + + +     		+ +

    DHCP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[tftp_id] +
    + + optional + , nil allowed + + +     		+ +

    TFTP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[httpboot_id] +
    + + optional + , nil allowed + + +     		+ +

    HTTPBoot Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[externalipam_id] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[template_id] +
    + + optional + , nil allowed + + +     		+ +

    Template HTTP(S) Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[bmc_id] +
    + + optional + , nil allowed + + +     		+ +

    BMC Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[boot_mode] +
    + + optional + , nil allowed + + +     		+ +

    Default boot mode for interfaces assigned to this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: Static, DHCP.

      +
      • +
    + + + +
    + subnet[subnet_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/subnets/:id + +
    + Update a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Subnet numeric identifier

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + subnet[name] +
    + + optional + + + +     		+ +

    Subnet name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[description] +
    + + optional + , nil allowed + + +     		+ +

    Subnet description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[network_type] +
    + + optional + , nil allowed + + +     		+ +

    Type or protocol, IPv4 or IPv6, defaults to IPv4

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPv4, IPv6.

      +
      • +
    + + + +
    + subnet[network] +
    + + optional + + + +     		+ +

    Subnet network

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[cidr] +
    + + optional + , nil allowed + + +     		+ +

    Network prefix in CIDR notation

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mask] +
    + + optional + , nil allowed + + +     		+ +

    Netmask for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[gateway] +
    + + optional + , nil allowed + + +     		+ +

    Subnet gateway

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_primary] +
    + + optional + , nil allowed + + +     		+ +

    Primary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_secondary] +
    + + optional + , nil allowed + + +     		+ +

    Secondary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[ipam] +
    + + optional + , nil allowed + + +     		+ +

    IP Address auto suggestion mode for this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.

      +
      • +
    + + + +
    + subnet[externalipam_group] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM group - only relevant when IPAM is set to external

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[from] +
    + + optional + , nil allowed + + +     		+ +

    Starting IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[to] +
    + + optional + , nil allowed + + +     		+ +

    Ending IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[vlanid] +
    + + optional + , nil allowed + + +     		+ +

    VLAN ID for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + subnet[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domains in which this subnet is part

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[dhcp_id] +
    + + optional + , nil allowed + + +     		+ +

    DHCP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[tftp_id] +
    + + optional + , nil allowed + + +     		+ +

    TFTP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[httpboot_id] +
    + + optional + , nil allowed + + +     		+ +

    HTTPBoot Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[externalipam_id] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[template_id] +
    + + optional + , nil allowed + + +     		+ +

    Template HTTP(S) Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[bmc_id] +
    + + optional + , nil allowed + + +     		+ +

    BMC Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[boot_mode] +
    + + optional + , nil allowed + + +     		+ +

    Default boot mode for interfaces assigned to this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: Static, DHCP.

      +
      • +
    + + + +
    + subnet[subnet_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/subnets/:id + +
    + Delete a subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Subnet numeric identifier

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/subnets/:id/freeip + +
    + Provides an unused IP address in this subnet +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + mac +
    + + optional + + + +     		+ +

    MAC address to reuse the IP for this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + excluded_ips +
    + + optional + + + +     		+ +

    IP addresses that should be excluded from suggestion

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets/create.html b/foreman/3.16/apidoc/v2/subnets/create.html new file mode 100644 index 00000000..423b3aec --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets/create.html @@ -0,0 +1,921 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/subnets +
    + Create a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + subnet +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + subnet[name] +
    + + required + + + +     		+ +

    Subnet name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[description] +
    + + optional + , nil allowed + + +     		+ +

    Subnet description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[network_type] +
    + + optional + , nil allowed + + +     		+ +

    Type or protocol, IPv4 or IPv6, defaults to IPv4

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPv4, IPv6.

      +
      • +
    + + + +
    + subnet[network] +
    + + required + + + +     		+ +

    Subnet network

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[cidr] +
    + + optional + , nil allowed + + +     		+ +

    Network prefix in CIDR notation

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mask] +
    + + optional + , nil allowed + + +     		+ +

    Netmask for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[gateway] +
    + + optional + , nil allowed + + +     		+ +

    Subnet gateway

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_primary] +
    + + optional + , nil allowed + + +     		+ +

    Primary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_secondary] +
    + + optional + , nil allowed + + +     		+ +

    Secondary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[ipam] +
    + + optional + , nil allowed + + +     		+ +

    IP Address auto suggestion mode for this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.

      +
      • +
    + + + +
    + subnet[externalipam_group] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM group - only relevant when IPAM is set to external

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[from] +
    + + optional + , nil allowed + + +     		+ +

    Starting IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[to] +
    + + optional + , nil allowed + + +     		+ +

    Ending IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[vlanid] +
    + + optional + , nil allowed + + +     		+ +

    VLAN ID for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + subnet[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domains in which this subnet is part

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[dhcp_id] +
    + + optional + , nil allowed + + +     		+ +

    DHCP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[tftp_id] +
    + + optional + , nil allowed + + +     		+ +

    TFTP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[httpboot_id] +
    + + optional + , nil allowed + + +     		+ +

    HTTPBoot Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[externalipam_id] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[template_id] +
    + + optional + , nil allowed + + +     		+ +

    Template HTTP(S) Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[bmc_id] +
    + + optional + , nil allowed + + +     		+ +

    BMC Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[boot_mode] +
    + + optional + , nil allowed + + +     		+ +

    Default boot mode for interfaces assigned to this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: Static, DHCP.

      +
      • +
    + + + +
    + subnet[subnet_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets/destroy.html b/foreman/3.16/apidoc/v2/subnets/destroy.html new file mode 100644 index 00000000..062facde --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets/destroy.html @@ -0,0 +1,167 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/subnets/:id +
    + Delete a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Subnet numeric identifier

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets/freeip.html b/foreman/3.16/apidoc/v2/subnets/freeip.html new file mode 100644 index 00000000..2ed0c33f --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets/freeip.html @@ -0,0 +1,221 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/subnets/:id/freeip +
    + Provides an unused IP address in this subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + mac +
    + + optional + + + +     		+ +

    MAC address to reuse the IP for this host

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + excluded_ips +
    + + optional + + + +     		+ +

    IP addresses that should be excluded from suggestion

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets/index.html b/foreman/3.16/apidoc/v2/subnets/index.html new file mode 100644 index 00000000..e990747b --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets/index.html @@ -0,0 +1,410 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/subnets +
    + List of subnets +

    +
    +
    +

    + GET /api/domains/:domain_id/subnets +
    + List of subnets for a domain +

    +
    +
    +

    + GET /api/locations/:location_id/subnets +
    + List of subnets per location +

    +
    +
    +

    + GET /api/organizations/:organization_id/subnets +
    + List of subnets per organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + domain_id +
    + + optional + + + +     		+ +

    ID of domain

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    boot_modestring
    dns_primarystring
    dns_secondarystring
    domainstring
    gatewaystring
    idinteger
    ipamstring
    locationstring
    location_idinteger
    maskstring
    mtuinteger
    nametext
    networkstring
    nic_delayinteger
    organizationstring
    organization_idinteger
    paramsstring
    typestring
    vlanidinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets/show.html b/foreman/3.16/apidoc/v2/subnets/show.html new file mode 100644 index 00000000..a8d1cbeb --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets/show.html @@ -0,0 +1,193 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/subnets/:id +
    + Show a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + show_hidden_parameters +
    + + optional + + + +     		+ +

    Display hidden parameter values

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/subnets/update.html b/foreman/3.16/apidoc/v2/subnets/update.html new file mode 100644 index 00000000..1e371988 --- /dev/null +++ b/foreman/3.16/apidoc/v2/subnets/update.html @@ -0,0 +1,949 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/subnets/:id +
    + Update a subnet +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Subnet numeric identifier

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + subnet[name] +
    + + optional + + + +     		+ +

    Subnet name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[description] +
    + + optional + , nil allowed + + +     		+ +

    Subnet description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[network_type] +
    + + optional + , nil allowed + + +     		+ +

    Type or protocol, IPv4 or IPv6, defaults to IPv4

    + +

    Validations:

    +
      +
    • +

      Must be one of: IPv4, IPv6.

      +
      • +
    + + + +
    + subnet[network] +
    + + optional + + + +     		+ +

    Subnet network

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[cidr] +
    + + optional + , nil allowed + + +     		+ +

    Network prefix in CIDR notation

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mask] +
    + + optional + , nil allowed + + +     		+ +

    Netmask for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[gateway] +
    + + optional + , nil allowed + + +     		+ +

    Subnet gateway

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_primary] +
    + + optional + , nil allowed + + +     		+ +

    Primary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[dns_secondary] +
    + + optional + , nil allowed + + +     		+ +

    Secondary DNS for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[ipam] +
    + + optional + , nil allowed + + +     		+ +

    IP Address auto suggestion mode for this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.

      +
      • +
    + + + +
    + subnet[externalipam_group] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM group - only relevant when IPAM is set to external

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[from] +
    + + optional + , nil allowed + + +     		+ +

    Starting IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[to] +
    + + optional + , nil allowed + + +     		+ +

    Ending IP Address for IP auto suggestion

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[vlanid] +
    + + optional + , nil allowed + + +     		+ +

    VLAN ID for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + subnet[mtu] +
    + + optional + , nil allowed + + +     		+ +

    MTU for this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + subnet[domain_ids] +
    + + optional + , nil allowed + + +     		+ +

    Domains in which this subnet is part

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[dhcp_id] +
    + + optional + , nil allowed + + +     		+ +

    DHCP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[tftp_id] +
    + + optional + , nil allowed + + +     		+ +

    TFTP Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[httpboot_id] +
    + + optional + , nil allowed + + +     		+ +

    HTTPBoot Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[externalipam_id] +
    + + optional + , nil allowed + + +     		+ +

    External IPAM Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[dns_id] +
    + + optional + , nil allowed + + +     		+ +

    DNS Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[template_id] +
    + + optional + , nil allowed + + +     		+ +

    Template HTTP(S) Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[bmc_id] +
    + + optional + , nil allowed + + +     		+ +

    BMC Proxy ID to use within this subnet

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + subnet[boot_mode] +
    + + optional + , nil allowed + + +     		+ +

    Default boot mode for interfaces assigned to this subnet.

    + +

    Validations:

    +
      +
    • +

      Must be one of: Static, DHCP.

      +
      • +
    + + + +
    + subnet[subnet_parameters_attributes] +
    + + optional + , nil allowed + + +     		+ +

    Array of parameters (name, value)

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + subnet[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/table_preferences.html b/foreman/3.16/apidoc/v2/table_preferences.html new file mode 100644 index 00000000..ae3861bb --- /dev/null +++ b/foreman/3.16/apidoc/v2/table_preferences.html @@ -0,0 +1,967 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Table_preferences + +
      • + +
    + +
    +

    + Table_preferences +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/users/:user_id/table_preferences + +
    + List of table preferences for a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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 /api/users/:user_id/table_preferences/:name + +
    + Table preference details of a given table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/users/:user_id/table_preferences + +
    + Creates a table preference for a given table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + columns +
    + + required + + + +     		+ +

    List of user selected columns

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/users/:user_id/table_preferences/:name + +
    + Updates a table preference for a given table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + columns +
    + + required + + + +     		+ +

    List of user selected columns

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/users/:user_id/table_preferences/:name + +
    + Delete a table preference for a given table +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/table_preferences/create.html b/foreman/3.16/apidoc/v2/table_preferences/create.html new file mode 100644 index 00000000..0b35fda3 --- /dev/null +++ b/foreman/3.16/apidoc/v2/table_preferences/create.html @@ -0,0 +1,223 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/users/:user_id/table_preferences +
    + Creates a table preference for a given table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + columns +
    + + required + + + +     		+ +

    List of user selected columns

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/table_preferences/destroy.html b/foreman/3.16/apidoc/v2/table_preferences/destroy.html new file mode 100644 index 00000000..9c21f305 --- /dev/null +++ b/foreman/3.16/apidoc/v2/table_preferences/destroy.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/users/:user_id/table_preferences/:name +
    + Delete a table preference for a given table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/table_preferences/index.html b/foreman/3.16/apidoc/v2/table_preferences/index.html new file mode 100644 index 00000000..8eee0054 --- /dev/null +++ b/foreman/3.16/apidoc/v2/table_preferences/index.html @@ -0,0 +1,279 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/table_preferences +
    + List of table preferences for a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/table_preferences/show.html b/foreman/3.16/apidoc/v2/table_preferences/show.html new file mode 100644 index 00000000..83f8be76 --- /dev/null +++ b/foreman/3.16/apidoc/v2/table_preferences/show.html @@ -0,0 +1,195 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:user_id/table_preferences/:name +
    + Table preference details of a given table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/table_preferences/update.html b/foreman/3.16/apidoc/v2/table_preferences/update.html new file mode 100644 index 00000000..631b95d9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/table_preferences/update.html @@ -0,0 +1,223 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/users/:user_id/table_preferences/:name +
    + Updates a table preference for a given table +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user_id +
    + + required + + + +     		+ +

    ID of the user

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + name +
    + + required + + + +     		+ +

    Name of the table

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + columns +
    + + required + + + +     		+ +

    List of user selected columns

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/tasks.html b/foreman/3.16/apidoc/v2/tasks.html new file mode 100644 index 00000000..e10a4d9e --- /dev/null +++ b/foreman/3.16/apidoc/v2/tasks.html @@ -0,0 +1,159 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Tasks +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/orchestration/:id/tasks + +
    + List all tasks for a given orchestration event +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/tasks/index.html b/foreman/3.16/apidoc/v2/tasks/index.html new file mode 100644 index 00000000..d15795e6 --- /dev/null +++ b/foreman/3.16/apidoc/v2/tasks/index.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/orchestration/:id/tasks +
    + List all tasks for a given orchestration event +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_combinations.html b/foreman/3.16/apidoc/v2/template_combinations.html new file mode 100644 index 00000000..976ceee1 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_combinations.html @@ -0,0 +1,1007 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    +
      +
    • + Foreman v2 + / +
      • +
    • + Template_combinations + +
      • + +
    + +
    +

    + Template_combinations +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_combination +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_combination[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    host group id

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_combination +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_combination[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    host group id

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/template_combinations/:id + +
    + Delete a template combination +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_combinations/create.html b/foreman/3.16/apidoc/v2/template_combinations/create.html new file mode 100644 index 00000000..b23e95a9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_combinations/create.html @@ -0,0 +1,256 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/provisioning_templates/:provisioning_template_id/template_combinations +
    + Add a template combination +

    +
    +
    +

    + POST /api/hostgroups/:hostgroup_id/template_combinations +
    + Add a template combination +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_combination +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_combination[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    host group id

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_combinations/destroy.html b/foreman/3.16/apidoc/v2/template_combinations/destroy.html new file mode 100644 index 00000000..b39a15e9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_combinations/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/template_combinations/:id +
    + Delete a template combination +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_combinations/index.html b/foreman/3.16/apidoc/v2/template_combinations/index.html new file mode 100644 index 00000000..dca65505 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_combinations/index.html @@ -0,0 +1,202 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/provisioning_templates/:provisioning_template_id/template_combinations +
    + List template combination +

    +
    +
    +

    + GET /api/hostgroups/:hostgroup_id/template_combinations +
    + List template combination +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_combinations/show.html b/foreman/3.16/apidoc/v2/template_combinations/show.html new file mode 100644 index 00000000..dfcd5e74 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_combinations/show.html @@ -0,0 +1,235 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/template_combinations/:id +
    + Show template combination +

    +
    +
    +

    + GET /api/provisioning_templates/:provisioning_template_id/template_combinations/:id +
    + Show template combination +

    +
    +
    +

    + GET /api/hostgroups/:hostgroup_id/template_combinations/:id +
    + Show template combination +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_combinations/update.html b/foreman/3.16/apidoc/v2/template_combinations/update.html new file mode 100644 index 00000000..568a9d9d --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_combinations/update.html @@ -0,0 +1,282 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/provisioning_templates/:provisioning_template_id/template_combinations/:id +
    + Update template combination +

    +
    +
    +

    + PUT /api/hostgroups/:hostgroup_id/template_combinations/:id +
    + Update template combination +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + provisioning_template_id +
    + + optional + + + +     		+ +

    ID of config template

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + hostgroup_id +
    + + optional + + + +     		+ +

    ID of host group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_combination +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_combination[hostgroup_id] +
    + + optional + , nil allowed + + +     		+ +

    host group id

    + +

    Validations:

    +
      +
    • +

      Must be a number.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_inputs.html b/foreman/3.16/apidoc/v2/template_inputs.html new file mode 100644 index 00000000..c70b963f --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_inputs.html @@ -0,0 +1,1621 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Template_inputs +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    input_typestring
    namestring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/templates/:template_id/template_inputs/:id + +
    + Show template input details +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/templates/:template_id/template_inputs + +
    + Create a template input +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + template_input +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_input[name] +
    + + required + + + +     		+ +

    Input name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[description] +
    + + optional + , nil allowed + + +     		+ +

    Input description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[required] +
    + + optional + , nil allowed + + +     		+ +

    Input is required

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[advanced] +
    + + optional + , nil allowed + + +     		+ +

    Input is advanced

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[input_type] +
    + + required + + + +     		+ +

    Input type

    + +

    Validations:

    +
      +
    • +

      Must be one of: user, fact, variable.

      +
      • +
    + + + +
    + template_input[fact_name] +
    + + optional + , nil allowed + + +     		+ +

    Fact name, used when input type is Fact value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[variable_name] +
    + + optional + , nil allowed + + +     		+ +

    Variable name, used when input type is Variable

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[options] +
    + + optional + , nil allowed + + +     		+ +

    Selectable values for user inputs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + template_input[default] +
    + + optional + , nil allowed + + +     		+ +

    Default value for user input

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[value_type] +
    + + optional + , nil allowed + + +     		+ +

    Value type, defaults to plain

    + +

    Validations:

    +
      +
    • +

      Must be one of: plain, search, date, resource.

      +
      • +
    + + + +
    + template_input[resource_type] +
    + + optional + , nil allowed + + +     		+ +

    For values of type search, this is the resource the value searches in

    + +

    Validations:

    +
      +
    • +

      Must be one of: Architecture, Audit, AuthSource, Bookmark, CommonParameter, ComputeProfile, ComputeResource, ConfigReport, Domain, FactValue, Host, Hostgroup, Image, Location, LookupValue, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, Realm, Report, ReportTemplate, Role, Setting, SmartProxy, Subnet, Test::Resource, User, Usergroup.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    + + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + template_input +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_input[name] +
    + + optional + + + +     		+ +

    Input name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[description] +
    + + optional + , nil allowed + + +     		+ +

    Input description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[required] +
    + + optional + , nil allowed + + +     		+ +

    Input is required

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[advanced] +
    + + optional + , nil allowed + + +     		+ +

    Input is advanced

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[input_type] +
    + + optional + + + +     		+ +

    Input type

    + +

    Validations:

    +
      +
    • +

      Must be one of: user, fact, variable.

      +
      • +
    + + + +
    + template_input[fact_name] +
    + + optional + , nil allowed + + +     		+ +

    Fact name, used when input type is Fact value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[variable_name] +
    + + optional + , nil allowed + + +     		+ +

    Variable name, used when input type is Variable

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[options] +
    + + optional + , nil allowed + + +     		+ +

    Selectable values for user inputs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + template_input[default] +
    + + optional + , nil allowed + + +     		+ +

    Default value for user input

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[value_type] +
    + + optional + , nil allowed + + +     		+ +

    Value type, defaults to plain

    + +

    Validations:

    +
      +
    • +

      Must be one of: plain, search, date, resource.

      +
      • +
    + + + +
    + template_input[resource_type] +
    + + optional + , nil allowed + + +     		+ +

    For values of type search, this is the resource the value searches in

    + +

    Validations:

    +
      +
    • +

      Must be one of: Architecture, Audit, AuthSource, Bookmark, CommonParameter, ComputeProfile, ComputeResource, ConfigReport, Domain, FactValue, Host, Hostgroup, Image, Location, LookupValue, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, Realm, Report, ReportTemplate, Role, Setting, SmartProxy, Subnet, Test::Resource, User, Usergroup.

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_inputs/create.html b/foreman/3.16/apidoc/v2/template_inputs/create.html new file mode 100644 index 00000000..4cbee577 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_inputs/create.html @@ -0,0 +1,527 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/templates/:template_id/template_inputs +
    + Create a template input +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + template_input +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_input[name] +
    + + required + + + +     		+ +

    Input name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[description] +
    + + optional + , nil allowed + + +     		+ +

    Input description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[required] +
    + + optional + , nil allowed + + +     		+ +

    Input is required

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[advanced] +
    + + optional + , nil allowed + + +     		+ +

    Input is advanced

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[input_type] +
    + + required + + + +     		+ +

    Input type

    + +

    Validations:

    +
      +
    • +

      Must be one of: user, fact, variable.

      +
      • +
    + + + +
    + template_input[fact_name] +
    + + optional + , nil allowed + + +     		+ +

    Fact name, used when input type is Fact value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[variable_name] +
    + + optional + , nil allowed + + +     		+ +

    Variable name, used when input type is Variable

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[options] +
    + + optional + , nil allowed + + +     		+ +

    Selectable values for user inputs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + template_input[default] +
    + + optional + , nil allowed + + +     		+ +

    Default value for user input

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[value_type] +
    + + optional + , nil allowed + + +     		+ +

    Value type, defaults to plain

    + +

    Validations:

    +
      +
    • +

      Must be one of: plain, search, date, resource.

      +
      • +
    + + + +
    + template_input[resource_type] +
    + + optional + , nil allowed + + +     		+ +

    For values of type search, this is the resource the value searches in

    + +

    Validations:

    +
      +
    • +

      Must be one of: Architecture, Audit, AuthSource, Bookmark, CommonParameter, ComputeProfile, ComputeResource, ConfigReport, Domain, FactValue, Host, Hostgroup, Image, Location, LookupValue, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, Realm, Report, ReportTemplate, Role, Setting, SmartProxy, Subnet, Test::Resource, User, Usergroup.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_inputs/destroy.html b/foreman/3.16/apidoc/v2/template_inputs/destroy.html new file mode 100644 index 00000000..8a02abb2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_inputs/destroy.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/templates/:template_id/template_inputs/:id +
    + Delete a template input +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_inputs/index.html b/foreman/3.16/apidoc/v2/template_inputs/index.html new file mode 100644 index 00000000..3d1b077a --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_inputs/index.html @@ -0,0 +1,307 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/templates/:template_id/template_inputs +
    + List template inputs +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    input_typestring
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_inputs/show.html b/foreman/3.16/apidoc/v2/template_inputs/show.html new file mode 100644 index 00000000..ed24e101 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_inputs/show.html @@ -0,0 +1,191 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/templates/:template_id/template_inputs/:id +
    + Show template input details +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_inputs/update.html b/foreman/3.16/apidoc/v2/template_inputs/update.html new file mode 100644 index 00000000..389cd311 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_inputs/update.html @@ -0,0 +1,553 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/templates/:template_id/template_inputs/:id +
    + Update a template input +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + template_id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + template_input +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + template_input[name] +
    + + optional + + + +     		+ +

    Input name

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[description] +
    + + optional + , nil allowed + + +     		+ +

    Input description

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[required] +
    + + optional + , nil allowed + + +     		+ +

    Input is required

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[advanced] +
    + + optional + , nil allowed + + +     		+ +

    Input is advanced

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[input_type] +
    + + optional + + + +     		+ +

    Input type

    + +

    Validations:

    +
      +
    • +

      Must be one of: user, fact, variable.

      +
      • +
    + + + +
    + template_input[fact_name] +
    + + optional + , nil allowed + + +     		+ +

    Fact name, used when input type is Fact value

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[variable_name] +
    + + optional + , nil allowed + + +     		+ +

    Variable name, used when input type is Variable

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[options] +
    + + optional + , nil allowed + + +     		+ +

    Selectable values for user inputs

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + template_input[default] +
    + + optional + , nil allowed + + +     		+ +

    Default value for user input

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + template_input[hidden_value] +
    + + optional + , nil allowed + + +     		+ +

    The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + template_input[value_type] +
    + + optional + , nil allowed + + +     		+ +

    Value type, defaults to plain

    + +

    Validations:

    +
      +
    • +

      Must be one of: plain, search, date, resource.

      +
      • +
    + + + +
    + template_input[resource_type] +
    + + optional + , nil allowed + + +     		+ +

    For values of type search, this is the resource the value searches in

    + +

    Validations:

    +
      +
    • +

      Must be one of: Architecture, Audit, AuthSource, Bookmark, CommonParameter, ComputeProfile, ComputeResource, ConfigReport, Domain, FactValue, Host, Hostgroup, Image, Location, LookupValue, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, Realm, Report, ReportTemplate, Role, Setting, SmartProxy, Subnet, Test::Resource, User, Usergroup.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_kinds.html b/foreman/3.16/apidoc/v2/template_kinds.html new file mode 100644 index 00000000..8fa80fc2 --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_kinds.html @@ -0,0 +1,296 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Template_kinds +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/template_kinds + +
    + List all template kinds +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    + + + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/template_kinds/index.html b/foreman/3.16/apidoc/v2/template_kinds/index.html new file mode 100644 index 00000000..c337af5c --- /dev/null +++ b/foreman/3.16/apidoc/v2/template_kinds/index.html @@ -0,0 +1,276 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/template_kinds +
    + List all template kinds +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/usergroups.html b/foreman/3.16/apidoc/v2/usergroups.html new file mode 100644 index 00000000..a4cdf2bc --- /dev/null +++ b/foreman/3.16/apidoc/v2/usergroups.html @@ -0,0 +1,820 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Usergroups +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/usergroups + +
    + List all user groups +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    rolestring
    role_idinteger
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/usergroups/:id + +
    + Show a user group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/usergroups + +
    + Create a user group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + usergroup[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin user group, can be modified by admins only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + usergroup[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[usergroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/usergroups/:id + +
    + Update a user group +

    +
    + + +
    + +

    User groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + usergroup[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin user group, can be modified by admins only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + usergroup[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[usergroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/usergroups/:id + +
    + Delete a user group +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/usergroups/create.html b/foreman/3.16/apidoc/v2/usergroups/create.html new file mode 100644 index 00000000..cbc531e4 --- /dev/null +++ b/foreman/3.16/apidoc/v2/usergroups/create.html @@ -0,0 +1,243 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/usergroups +
    + Create a user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + usergroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + usergroup[name] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin user group, can be modified by admins only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + usergroup[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[usergroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/usergroups/destroy.html b/foreman/3.16/apidoc/v2/usergroups/destroy.html new file mode 100644 index 00000000..020dcc25 --- /dev/null +++ b/foreman/3.16/apidoc/v2/usergroups/destroy.html @@ -0,0 +1,111 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/usergroups/:id +
    + Delete a user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/usergroups/index.html b/foreman/3.16/apidoc/v2/usergroups/index.html new file mode 100644 index 00000000..163777cd --- /dev/null +++ b/foreman/3.16/apidoc/v2/usergroups/index.html @@ -0,0 +1,232 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/usergroups +
    + List all user groups +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    idinteger
    namestring
    rolestring
    role_idinteger
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/usergroups/show.html b/foreman/3.16/apidoc/v2/usergroups/show.html new file mode 100644 index 00000000..5cd87390 --- /dev/null +++ b/foreman/3.16/apidoc/v2/usergroups/show.html @@ -0,0 +1,111 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/usergroups/:id +
    + Show a user group +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/usergroups/update.html b/foreman/3.16/apidoc/v2/usergroups/update.html new file mode 100644 index 00000000..c4577ddf --- /dev/null +++ b/foreman/3.16/apidoc/v2/usergroups/update.html @@ -0,0 +1,271 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/usergroups/:id +
    + Update a user group +

    +
    + +
    + + +

    User groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + usergroup[name] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin user group, can be modified by admins only

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + usergroup[user_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[usergroup_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + usergroup[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users.html b/foreman/3.16/apidoc/v2/users.html new file mode 100644 index 00000000..fae3e89a --- /dev/null +++ b/foreman/3.16/apidoc/v2/users.html @@ -0,0 +1,2176 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + Users +
    + +

    +
    + + + + + + +
    + +
    +
    + >>> +
    +
    +

    + + GET /api/users + +
    + List all users +

    +

    + + GET /api/auth_source_ldaps/:auth_source_ldap_id/users + +
    + List all users for LDAP authentication source +

    +

    + + GET /api/auth_source_externals/:auth_source_external_id/users + +
    + List all users for external authentication source +

    +

    + + GET /api/usergroups/:usergroup_id/users + +
    + List all users for user group +

    +

    + + GET /api/roles/:role_id/users + +
    + List all users for role +

    +

    + + GET /api/locations/:location_id/users + +
    + List all users for location +

    +

    + + GET /api/organizations/:organization_id/users + +
    + List all users for organization +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + auth_source_ldap_id +
    + + optional + + + +     		+ +

    ID of LDAP authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup_id +
    + + optional + + + +     		+ +

    ID of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role_id +
    + + optional + + + +     		+ +

    ID of role

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    admintrue, false
    auth_sourcestring
    auth_source_typestring
    descriptiontext
    disabledtrue, false
    firstnamestring
    idinteger
    last_login_ondatetime
    lastnamestring
    locationstring
    location_idinteger
    loginstring
    mailstring
    organizationstring
    organization_idinteger
    rolestring
    role_idinteger
    usergroupstring
    + + + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/users/:id + +
    + Show a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/current_user + +
    + Show the currently logged-in user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + POST /api/users + +
    + Create a user +

    +
    + + +
    + +

    Adds role 'Default role' to the user by default

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + user[login] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[firstname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[lastname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[mail] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[disabled] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin account

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[password] +
    + + optional + , nil allowed + + +     		+ +

    Required unless user is in an external authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[default_location_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[default_organization_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[auth_source_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[timezone] +
    + + optional + , nil allowed + + +     		+ +

    User's timezone

    + +

    Validations:

    +
      +
    • +

      Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US &amp; Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US &amp; Canada), Central America, Central Time (US &amp; Canada), Chihuahua, Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US &amp; Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku&#39;alofa, Samoa, Tokelau Is..

      +
      • +
    + + + +
    + user[locale] +
    + + optional + , nil allowed + + +     		+ +

    User's preferred locale

    + +

    Validations:

    +
      +
    • +

      Must be one of: en.

      +
      • +
    + + + +
    + user[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[mail_enabled] +
    + + optional + , nil allowed + + +     		+ +

    Enable user's email

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + PUT /api/users/:id + +
    + Update a user +

    +
    + + +
    + +

    Adds role 'Default role' to the user if it is not already present. Only another admin can change the admin account attribute.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + user[login] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[firstname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[lastname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[mail] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[disabled] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin account

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[password] +
    + + optional + , nil allowed + + +     		+ +

    Required unless user is in an external authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[default_location_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[default_organization_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[auth_source_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[timezone] +
    + + optional + , nil allowed + + +     		+ +

    User's timezone

    + +

    Validations:

    +
      +
    • +

      Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US &amp; Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US &amp; Canada), Central America, Central Time (US &amp; Canada), Chihuahua, Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US &amp; Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku&#39;alofa, Samoa, Tokelau Is..

      +
      • +
    + + + +
    + user[locale] +
    + + optional + , nil allowed + + +     		+ +

    User's preferred locale

    + +

    Validations:

    +
      +
    • +

      Must be one of: en.

      +
      • +
    + + + +
    + user[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[mail_enabled] +
    + + optional + , nil allowed + + +     		+ +

    Enable user's email

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[current_password] +
    + + optional + , nil allowed + + +     		+ +

    Required when user want to change own password

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + DELETE /api/users/:id + +
    + Delete a user +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    +
    +
    + >>> +
    +
    +

    + + GET /api/users/extlogin + +
    + Use to authenticate against external authentication source +

    +
    + + +
    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/create.html b/foreman/3.16/apidoc/v2/users/create.html new file mode 100644 index 00000000..1d6b41e9 --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/create.html @@ -0,0 +1,623 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + POST /api/users +
    + Create a user +

    +
    + +
    + + +

    Adds role 'Default role' to the user by default

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + user[login] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[firstname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[lastname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[mail] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[disabled] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin account

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[password] +
    + + optional + , nil allowed + + +     		+ +

    Required unless user is in an external authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[default_location_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[default_organization_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[auth_source_id] +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[timezone] +
    + + optional + , nil allowed + + +     		+ +

    User's timezone

    + +

    Validations:

    +
      +
    • +

      Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US &amp; Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US &amp; Canada), Central America, Central Time (US &amp; Canada), Chihuahua, Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US &amp; Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku&#39;alofa, Samoa, Tokelau Is..

      +
      • +
    + + + +
    + user[locale] +
    + + optional + , nil allowed + + +     		+ +

    User's preferred locale

    + +

    Validations:

    +
      +
    • +

      Must be one of: en.

      +
      • +
    + + + +
    + user[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[mail_enabled] +
    + + optional + , nil allowed + + +     		+ +

    Enable user's email

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/destroy.html b/foreman/3.16/apidoc/v2/users/destroy.html new file mode 100644 index 00000000..e8030c6d --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/destroy.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + DELETE /api/users/:id +
    + Delete a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/extlogin.html b/foreman/3.16/apidoc/v2/users/extlogin.html new file mode 100644 index 00000000..7da940fb --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/extlogin.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/extlogin +
    + Use to authenticate against external authentication source +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/index.html b/foreman/3.16/apidoc/v2/users/index.html new file mode 100644 index 00000000..f9b5cbf8 --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/index.html @@ -0,0 +1,482 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users +
    + List all users +

    +
    +
    +

    + GET /api/auth_source_ldaps/:auth_source_ldap_id/users +
    + List all users for LDAP authentication source +

    +
    +
    +

    + GET /api/auth_source_externals/:auth_source_external_id/users +
    + List all users for external authentication source +

    +
    +
    +

    + GET /api/usergroups/:usergroup_id/users +
    + List all users for user group +

    +
    +
    +

    + GET /api/roles/:role_id/users +
    + List all users for role +

    +
    +
    +

    + GET /api/locations/:location_id/users +
    + List all users for location +

    +
    +
    +

    + GET /api/organizations/:organization_id/users +
    + List all users for organization +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + auth_source_ldap_id +
    + + optional + + + +     		+ +

    ID of LDAP authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + usergroup_id +
    + + optional + + + +     		+ +

    ID of user group

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + role_id +
    + + optional + + + +     		+ +

    ID of role

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + location_id +
    + + optional + + + +     		+ +

    Scope by locations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Scope by organizations

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + search +
    + + optional + + + +     		+ +

    filter results

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + order +
    + + optional + + + +     		+ +

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

    + +

    Validations:

    +
      +
    • +

      Must be a 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$/.

      +
      • +
    + + + +
    + +

    Search fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field nameTypePossible values
    admintrue, false
    auth_sourcestring
    auth_source_typestring
    descriptiontext
    disabledtrue, false
    firstnamestring
    idinteger
    last_login_ondatetime
    lastnamestring
    locationstring
    location_idinteger
    loginstring
    mailstring
    organizationstring
    organization_idinteger
    rolestring
    role_idinteger
    usergroupstring
    + + + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/show.html b/foreman/3.16/apidoc/v2/users/show.html new file mode 100644 index 00000000..2c80487c --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/show.html @@ -0,0 +1,165 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/users/:id +
    + Show a user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/show_current.html b/foreman/3.16/apidoc/v2/users/show_current.html new file mode 100644 index 00000000..34db97cf --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/show_current.html @@ -0,0 +1,139 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + GET /api/current_user +
    + Show the currently logged-in user +

    +
    + +
    + + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/apidoc/v2/users/update.html b/foreman/3.16/apidoc/v2/users/update.html new file mode 100644 index 00000000..96de4b7b --- /dev/null +++ b/foreman/3.16/apidoc/v2/users/update.html @@ -0,0 +1,677 @@ + + + + API documentation + + + + + + + + + + +
    +
    +
    + + +
    +

    + PUT /api/users/:id +
    + Update a user +

    +
    + +
    + + +

    Adds role 'Default role' to the user if it is not already present. Only another admin can change the admin account attribute.

    + + + + + +

    Params

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Param nameDescription
    + location_id +
    + + optional + + + +     		+ +

    Set the current location context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + organization_id +
    + + optional + + + +     		+ +

    Set the current organization context for the request

    + +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + id +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user +
    + + required + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Hash

      +
      • +
    + + + +
    + user[login] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[firstname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[lastname] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[mail] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[description] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[disabled] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[admin] +
    + + optional + , nil allowed + + +     		+ +

    is an admin account

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[password] +
    + + optional + , nil allowed + + +     		+ +

    Required unless user is in an external authentication source

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + user[default_location_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[default_organization_id] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[auth_source_id] +
    + + optional + + + +     		+ +

    Validations:

    +
      +
    • +

      Must be a Integer

      +
      • +
    + + + +
    + user[timezone] +
    + + optional + , nil allowed + + +     		+ +

    User's timezone

    + +

    Validations:

    +
      +
    • +

      Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US &amp; Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US &amp; Canada), Central America, Central Time (US &amp; Canada), Chihuahua, Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US &amp; Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku&#39;alofa, Samoa, Tokelau Is..

      +
      • +
    + + + +
    + user[locale] +
    + + optional + , nil allowed + + +     		+ +

    User's preferred locale

    + +

    Validations:

    +
      +
    • +

      Must be one of: en.

      +
      • +
    + + + +
    + user[role_ids] +
    + + optional + , nil allowed + + +     		+ +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[mail_enabled] +
    + + optional + , nil allowed + + +     		+ +

    Enable user's email

    + +

    Validations:

    +
      +
    • +

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

      +
      • +
    + + + +
    + user[location_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE locations with given ids

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[organization_ids] +
    + + optional + , nil allowed + + +     		+ +

    REPLACE organizations with given ids.

    + +

    Validations:

    +
      +
    • +

      Must be an array of any type

      +
      • +
    + + + +
    + user[current_password] +
    + + optional + , nil allowed + + +     		+ +

    Required when user want to change own password

    + +

    Validations:

    +
      +
    • +

      Must be a String

      +
      • +
    + + + +
    + + + + +
    + + + + +
    +
    +
    +
    +
    + + + + + + diff --git a/foreman/3.16/index.html b/foreman/3.16/index.html new file mode 100644 index 00000000..fd1a2d49 --- /dev/null +++ b/foreman/3.16/index.html @@ -0,0 +1,6 @@ + + + + +

    If you are not redirected in one second, click here.

    + diff --git a/foreman/latest b/foreman/latest index 56e972a2..1bc446c8 120000 --- a/foreman/latest +++ b/foreman/latest @@ -1 +1 @@ -3.5 \ No newline at end of file +3.16 \ No newline at end of file diff --git a/index.html b/index.html index 9a8367ea..d5616033 100644 --- a/index.html +++ b/index.html @@ -9,6 +9,7 @@

    Foreman API documentation

    Foreman core API