GET /api/remote_execution_features
List remote execution features

Examples

GET /api/remote_execution_features
200
{
  "total": 27,
  "subtotal": 27,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 1,
      "label": "katello_package_install",
      "name": "Katello: Install Package",
      "description": "Install package via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 2,
      "label": "katello_package_install_by_search",
      "name": "Katello: Install packages by search query",
      "description": "Install packages via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 3,
      "label": "katello_package_update",
      "name": "Katello: Update Package",
      "description": "Update package via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 4,
      "label": "katello_packages_update_by_search",
      "name": "Katello: Update Packages by search query",
      "description": "Update packages via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 5,
      "label": "katello_package_remove",
      "name": "Katello: Remove Package",
      "description": "Remove package via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 6,
      "label": "katello_packages_remove_by_search",
      "name": "Katello: Remove Packages by search query",
      "description": "Remove packages via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 7,
      "label": "katello_group_install",
      "name": "Katello: Install Package Group",
      "description": "Install package group via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 8,
      "label": "katello_group_update",
      "name": "Katello: Update Package Group",
      "description": "Update package group via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 9,
      "label": "katello_group_remove",
      "name": "Katello: Remove Package Group",
      "description": "Remove package group via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 10,
      "label": "katello_errata_install",
      "name": "Katello: Install Errata",
      "description": "Install errata via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 11,
      "label": "katello_errata_install_by_search",
      "name": "Katello: Install errata by search query",
      "description": "Install errata using scoped search query",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 12,
      "label": "katello_service_restart",
      "name": "Katello: Service Restart",
      "description": "Restart Services via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 13,
      "label": "katello_host_tracer_resolve",
      "name": "Katello: Resolve Traces",
      "description": "Resolve traces via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 14,
      "label": "katello_change_content_source",
      "name": "Katello: Configure host for new content source",
      "description": "Replace content source on the target machine",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 15,
      "label": "katello_upload_profile",
      "name": "Katello: Upload Profile",
      "description": "Upload package / repos profile",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 16,
      "label": "katello_module_stream_action",
      "name": "Katello: Module Stream Actions",
      "description": "Perform a module stream action via Katello interface",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 17,
      "label": "rh_cloud_remediate_hosts",
      "name": "Apply Insights recommendations",
      "description": "Run remediation playbook generated by Insights",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 18,
      "label": "rh_cloud_connector_run_playbook",
      "name": "Run RH Cloud playbook",
      "description": "Run playbook genrated by Red Hat remediations app",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 19,
      "label": "ansible_configure_cloud_connector",
      "name": "Configure Cloud Connector on given hosts",
      "description": "Configure Cloud Connector on given hosts",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 20,
      "label": "puppet_run_host",
      "name": "Run Puppet Once",
      "description": "Perform a single Puppet run",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": true
    },
    {
      "id": 21,
      "label": "run_script",
      "name": "Run Script",
      "description": "Run a script",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 22,
      "label": "ansible_run_host",
      "name": "Run Ansible roles",
      "description": "Runs an Ansible playbook which contains all the roles defined for a host",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": true
    },
    {
      "id": 23,
      "label": "ansible_run_insights_plan",
      "name": "Ansible: Run Insights maintenance plan",
      "description": "Runs a given maintenance plan from Red Hat Access Insights given an ID.",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 24,
      "label": "ansible_run_playbook",
      "name": "Run playbook",
      "description": "Run an Ansible playbook against given hosts",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 25,
      "label": "ansible_enable_web_console",
      "name": "Enable web console",
      "description": "Run an Ansible playbook to enable web console on given hosts",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": true
    },
    {
      "id": 26,
      "label": "ansible_run_capsule_upgrade",
      "name": "Upgrade Capsules on given hosts",
      "description": "Upgrade Capsules on given Capsule server hosts",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    },
    {
      "id": 45,
      "label": "my_awesome_feature",
      "name": "My awesome feature",
      "description": "You will not believe what it does",
      "job_template_id": null,
      "job_template_name": null,
      "host_action_button": false
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer


GET /api/remote_execution_features/:id
Show remote execution feature

Examples

GET /api/remote_execution_features/my_awesome_feature
200
{
  "id": 44,
  "label": "my_awesome_feature",
  "name": "My awesome feature",
  "description": "You will not believe what it does",
  "job_template_id": null,
  "job_template_name": null,
  "host_action_button": false
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Validations:

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


PUT /api/remote_execution_features/:id
Update a job template

Examples

PUT /api/remote_execution_features/my_awesome_feature
{
  "job_template_id": 1007982075,
  "remote_execution_feature": {
    "job_template_id": 1007982075
  }
}
200
{
  "job_template_id": 1007982075,
  "id": 43,
  "label": "my_awesome_feature",
  "name": "My awesome feature",
  "description": "You will not believe what it does",
  "provided_inputs": "awesomeness_level",
  "host_action_button": false,
  "notification_builder": null,
  "proxy_selector_override": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Validations:

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

remote_execution_feature
required

Validations:

  • Hash

remote_execution_feature[job_template_id]
optional

Job template ID to be used for the feature

Validations:

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


GET /api/api/hosts/:id/available_remote_execution_features
List available remote execution features for a host

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Validations:

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