Configure hosts by using Ansible Director

In the orcharhino management UI, navigate to Administer > About.

On the Plugins tab, verify the installation of the Ansible Director plugin.

In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

Select your orcharhino Proxy.

On the Overview tab, verify that Ansible Director is listed under Active features.

In the orcharhino management UI, navigate to Administer > Settings.

Select the Ansible Director tab.

Adjust the plugin to your environment. For example, you can configure a different default version of ansible-core.

In the orcharhino management UI, navigate to Administer > Settings.

Reload the Ansible Director tab and verify that orcharhino updated the plugin settings.

Create a JSON file, for example, data.json to define the value of the setting:

{
  "value": "2.20.4"
}

Configure the Ansible director plugin to your environment. For example, you can change the default version of ansible-core:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PUT \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/settings/ad_default_ansible_core_version/ \
| jq

In the orcharhino management UI, navigate to Ansible > Content.

Click Import Ansible content.

Select Ansible Galaxy as source and click Next.

In the Identifier field, enter the namespace and name of the Ansible content separated by a dot.

In the Source field, enter the URL of your Ansible Galaxy. By default, it uses galaxy.ansible.com.

In the Versions field, you can add versions to limit the synchronization to one or multiple versions. Click the + sign or press enter after each version.

Click Add Ansible collection to batch.

Click Next.

Review your content. You can click Delete to remove an Ansible collection from the batch.

Click Finish to import Ansible content.

In the orcharhino management UI, navigate to Ansible > Content.

For your imported Ansible content, click the arrow symbol to view the list of imported versions.

Verify that orcharhino contains all selected Ansible content and versions.

Create a JSON file, for example, data.json to define your Ansible content:

{
  "organization_id": "My_Organization_ID",
  "units": [
    {
      "unit_name": "My_Namespace.My_Name",
      "unit_type": "collection",
      "unit_source_type": "galaxy",
      "unit_source": "https://galaxy.ansible.com",
      "unit_versions": [
        "My_First_Version",
        "My_Second_Version"
      ]
    }
  ]
}

Import Ansible content from Ansible Galaxy:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq

{
  "id": "My_Task_ID",
  "label": "ForemanAnsibleDirector::Actions::AnsibleContentUnit::Bulk::Import",
  "started_at": "2026-03-11 09:59:31 UTC"
}

In the orcharhino management UI, navigate to Ansible > Content.

Click Import Ansible content.

Select Git repository as source and click Next.

In the Identifier field, enter the namespace and name of your Ansible collection as specified in galaxy.yml separated by a dot.

In the Repository URL field, enter the URL of your Git repository ending with .git.

If you want to limit the synchronization of Ansible content to specific Git references, enter them in the References field. Click the + sign or press enter after each version.

Click Add Ansible collection to batch.

Click Next.

Review your content. You can click Delete to remove an Ansible collection from the batch.

Click Finish to import Ansible content.

In the orcharhino management UI, navigate to Ansible > Content.

For your imported Ansible content, click the arrow symbol to view the list of imported versions.

Verify that orcharhino contains all selected Ansible content and versions.

Create a JSON file, for example, data.json to define your Ansible content:

{
  "organization_id": "My_Organization_ID",
  "units": [
    {
      "unit_name": "My_Namespace.My_Name",
      "unit_type": "collection",
      "unit_source_type": "galaxy",
      "unit_source": "https://galaxy.ansible.com",
      "unit_versions": [
        "My_First_Version",
        "My_Second_Version"
      ]
    }
  ]
}

Import Ansible content from a Git repository:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq

{
  "id": "My_Task_ID",
  "label": "ForemanAnsibleDirector::Actions::AnsibleContentUnit::Bulk::Import",
  "started_at": "2026-03-11 09:59:31 UTC"
}

In the orcharhino management UI, navigate to Ansible > Content.

Click Import Ansible content.

Select YML file as source.

In the orcharhino management UI, navigate to Ansible > Content.

For your imported Ansible content, click the arrow symbol to view the list of imported versions.

Verify that orcharhino contains all selected Ansible content and versions.

Create a JSON file, for example, data.json to define your Ansible content:

{
  "organization_id": "My_Organization_ID",
  "units": [
    {
      "unit_name": "My_Namespace.My_Name",
      "unit_type": "collection",
      "unit_source_type": "galaxy",
      "unit_source": "https://galaxy.ansible.com",
      "unit_versions": [
        "My_First_Version",
        "My_Second_Version"
      ]
    }
  ]
}

Import Ansible content based on a YML file:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq

{
  "id": "My_Task_ID",
  "label": "ForemanAnsibleDirector::Actions::AnsibleContentUnit::Bulk::Import",
  "started_at": "2026-03-11 09:59:31 UTC"
}

In the orcharhino management UI, navigate to Ansible > Content.

For the content that you want to delete, from the options menu, click Delete.

Click Confirm.

In the orcharhino management UI, navigate to Ansible > Content.

Verify that the content you have deleted is not part of the list anymore.

Optional: List imported Ansible content:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define the Ansible content that you want to delete:

{
  "units": [
    {
      "unit_id": "My_Ansible_Content_ID"
    }
  ]
}

Delete imported Ansible content from orcharhino:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request DELETE \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq

In the orcharhino management UI, navigate to Ansible > Content.

Click the arrow symbol next to your imported Ansible content.

For the version that you want to delete, from the options menu, click Delete.

Click Confirm.

In the orcharhino management UI, navigate to Ansible > Content.

Click the arrow symbol next to your imported Ansible content.

Verify that the version you have deleted is not part of the list anymore.

Optional: List imported Ansible content:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define the versions of your Ansible content that you want to delete:

{
  "units": [
    {
      "unit_id": "My_Ansible_Content_ID",
      "unit_version_ids": [
        "My_First_Version_ID",
        "My_Second_Version_ID"
      ]
    }
  ]
}

Delete versions of imported Ansible content from orcharhino:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request DELETE \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq

In the orcharhino management UI, navigate to Ansible > Content.

From the list of Ansible content, select a version.

Select an Ansible role.

Use the toggle to enable the variable override.

Click the Edit icon.

On the Base variable tab, click the Edit icon.

In the Default value field, enter your custom default value.

Click the Save icon to submit your change to orcharhino.

In the orcharhino management UI, navigate to Ansible > Content.

From the list of Ansible content, select a version.

Select an Ansible role.

Use the toggle to enable the variable override.

Click the Edit icon.

Verify that orcharhino contains your custom default value.

Optional: Get a list of Ansible content IDs:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq ".results [] .id"

Optional: Get a list of Ansible roles in your Ansible content:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles [] .name"

Optional: Get a list of variables in your Ansible roles:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles []" | jq 'select(.name == "My_Ansible_Role_Name")' | jq ".variables []"

Create a JSON file, for example, data.json to define your custom default value:

{
  "ansible_variable": {
    "key": "My_Ansible_Variable_Name",
    "type": "My_Ansible_Variable_Type",
    "default_value": "My_Default_Value",
    "overridable": true
  }
}

Set a custom default value for an Ansible variable:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_variables/My_Ansible_Variable_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Content.

From the list of Ansible content, select a version.

Select an Ansible role.

Use the toggle to enable the variable override.

Click the Edit icon.

On the Overrides tab, click Create override.

Set the toggle to Simple Matcher Creation.

In the Matcher type menu, select your simple matcher type.

In the Matcher value menu, select your simple matcher value.

In the Override value field, enter your custom value.

Click Submit to save your override.

In the orcharhino management UI, navigate to Ansible > Content.

From the list of Ansible content, select a version.

Select an Ansible role.

Use the toggle to enable the variable override.

Click the Edit icon.

Verify that orcharhino contains your custom value.

Optional: Get a list of Ansible content IDs:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq ".results [] .id"

Optional: Get a list of Ansible roles in your Ansible content:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles [] .name"

Optional: Get a list of variables in your Ansible roles:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles []" | jq 'select(.name == "My_Ansible_Role_Name")' | jq ".variables []"

Create a JSON file, for example, data.json to define your custom value:

{
  "override": {
    "value": "My_Custom_Value",
    "matcher": "My_Matcher_Type",
    "matcher_value": "My_Matcher_Value"
  }
}

Set a custom value for an Ansible variable:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_variables/My_Ansible_Variable_ID/overrides/ \
| jq

In the orcharhino management UI, navigate to Ansible > Content.

From the list of Ansible content, select a version.

Select an Ansible role.

Use the toggle to enable the variable override.

Click the Edit icon.

On the Base variable tab, click the Edit icon.

In the Default value field, enter your custom default value.

Click the Save icon to submit your change to orcharhino.

In the orcharhino management UI, navigate to Ansible > Content.

From the list of Ansible content, select a version.

Select an Ansible role.

Use the toggle to enable the variable override.

Click the Edit icon.

Verify that orcharhino contains your custom value.

Optional: Get a list of Ansible content IDs:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq ".results [] .id"

Optional: Get a list of Ansible roles in your Ansible content:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles [] .name"

Optional: Get a list of variables in your Ansible roles:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles []" | jq 'select(.name == "My_Ansible_Role_Name")' | jq ".variables []"

Create a JSON file, for example, data.json to define your custom value:

{
  "override": {
    "value": "My_Custom_Value",
    "matcher": "My_Matcher_Type",
    "matcher_value": "My_Matcher_Value"
  }
}

Set a custom value for an Ansible variable:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_variables/My_Ansible_Variable_ID/overrides/ \
| jq

In the orcharhino management UI, navigate to Hosts > All Hosts.

Select your host.

On the Ansible Director tab, select the Variables tab.

From the list of customizable variables, click the Edit icon for the variable that you want to override.

In the Edit override window, set the custom value for your host.

Click Confirm to submit your change to orcharhino.

In the orcharhino management UI, navigate to Hosts > All Hosts.

Select your host.

On the Ansible Director tab, select the Variables tab.

From the list of customizable variables, click the Edit icon for the variable that you want to override.

Optional: Get a list of Ansible content IDs:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/ \
| jq ".results [] .id"

Optional: Get a list of Ansible roles in your Ansible content:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles [] .name"

Optional: Get a list of variables in your Ansible roles:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Content_ID/ \
| jq ".roles []" | jq 'select(.name == "My_Ansible_Role_Name")' | jq ".variables []"

Create a JSON file, for example, data.json to define a custom value for your host:

{
  "override": {
    "value": "My_Custom_Value",
    "matcher": "fqdn",
    "matcher_value": "My_FQDN"
  }
}

Set a custom value for an Ansible variable for your host:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_variables/My_Ansible_Variable_ID/overrides/ \
| jq

In the orcharhino management UI, navigate to Ansible > Execution Environments.

Click Create Execution Environment.

In the Name field, enter the name of your Ansible Execution Environment.

In the Base-Image URL field, enter the name of the base container image. You can reference any container image from an OCI-compatible container registry or any container image that you have synchronized to orcharhino.

In the Ansible version field, enter the version of ansible-core.

Click the Save icon to save your Ansible Execution Environment.

In the orcharhino management UI, navigate to Ansible > Execution Environments.

For your Ansible Execution Environment, verify that the build status icon is green.

Create a JSON file, for example, data.json to define your Ansible Execution Environment:

{
  "organization_id": "My_Organization_ID",
  "execution_environment": {
    "name": "My_Ansible_Execution_Environment_Name",
    "base_image_url": "My_Base_Container_Image_URL",
    "ansible_version": "My_Ansible_Version"
  }
}

Build your Ansible Execution Environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/execution_environments/ \
| jq

In the orcharhino management UI, navigate to Ansible > Execution Environments.

For your Ansible Execution Environment, click the Edit icon.

Click the Save icon to change your Ansible Execution Environment.

In the orcharhino management UI, navigate to Ansible > Execution Environments.

For your Ansible Execution Environments, verify that the build status icon is green.

Optional: Get a list of your Ansible Execution Environment:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/execution_environments/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define your Ansible Execution Environment:

{
  "execution_environment": {
    "name": "My_Ansible_Execution_Environment_Name",
    "base_image_url": "My_Container_Image_URL",
    "ansible_version": "My_Ansible_Version"
  }
}

Change your Ansible Execution Environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/ansible_content/My_Ansible_Execution_Environment_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Execution Environments.

For your Ansible Execution Environment, click the Delete icon.

Click Confirm to delete your Ansible Execution Environment from orcharhino.

In the orcharhino management UI, navigate to Ansible > Execution Environments.

Verify that orcharhino does not contain your deleted Ansible Execution Environment.

Optional: List all Ansible Execution Environments in orcharhino:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/execution_environments/ \
| jq ".results | .[]"

Delete your Ansible Execution Environment from orcharhino:

$ curl \
--header "Accept: application/json" \
--request DELETE \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/execution_environments/My_Ansible_Execution_Environment_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

Click Create lifecycle environment path.

In the Unnamed LCE Path field, click the Edit icon.

Enter a name for your lifecycle environment path and click the Save icon.

Click Confirm to rename your lifecycle environment path.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino shows your newly created lifecycle environment path.

Create a JSON file, for example, data.json to define your Ansible lifecycle environment path:

{
  "lifecycle_environment_path": {
    "name": "My_Ansible_Lifecycle_Environment_Path_Name"
  },
  "organization_id": "My_Organization_ID"
}

Create an Ansible lifecycle environment path:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

In your Ansible lifecycle environment path, click the Delete icon.

Click Confirm to delete your Ansible lifecycle environment path.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino does not contain your previously deleted Ansible lifecycle environment path.

Optional: List all Ansible lifecycle environment paths in orcharhino:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/ \
| jq ".results | .[]"

Delete your Ansible lifecycle environment path from orcharhino:

$ curl \
--header "Accept: application/json" \
--request DELETE \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/My_Ansible_Lifecycle_Environment_Path_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

In your Ansible lifecycle environment path, click Create lifecycle environment.

For your Ansible lifecycle environment, click None next to Execution Environment.

From the list of Ansible Execution Environments, click Assign for the Execution Environment that you want to use for this lifecycle environment.

For your Ansible lifecycle environment, click the Ansible icon.

From the list of Ansible content, select Ansible content that you want to use for this lifecycle environment.

Click Confirm to assign content to your lifecycle environment.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino shows your newly created lifecycle environment.

Optional: Get a list of all Ansible lifecycle environment paths:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define your Ansible lifecycle environment:

{
  "lifecycle_environment": {
    "name": "My_Ansible_Lifecycle_Environment_Name",
    "position": -1
  },
  "lifecycle_environment_path_id": "My_Ansible_Lifecycle_Environment_Path_ID",
  "organization_id": "My_Organization_ID"
}

Create an Ansible lifecycle environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/ \
| jq

Create a JSON file, for example, data.json to define the Ansible Execution Environment of your Ansible lifecycle environment:

{
  "lifecycle_environment": {
    "description": "My_Description",
    "name": "My_Ansible_Lifecycle_Environment_Name",
    "execution_environment_id": "My_Ansible_Execution_Environment_ID"
  }
}

Assign an Ansible Execution Environment to your Ansible lifecycle environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PUT \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_ID/ \
| jq

Create a JSON file, for example, data.json to define the Ansible content of your Ansible lifecycle environment:

{
  "content_assignments": [
    {
      "id": "My_Ansible_Content_ID",
      "version": "My_Ansible_Content_Version"
    }
  ],
  "organization_id": "My_Organization_ID"
}

Assign Ansible content to your Ansible lifecycle environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

In your Ansible lifecycle environment path, for your Ansible lifecycle environment, click None next to Execution Environment.

From the list of Ansible Execution Environments, click Assign for the Execution Environment that you want to use for this lifecycle environment.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino shows your newly assigned Ansible Execution Environment for your selected Ansible lifecycle environment.

Optional: Get a list of all Ansible Execution Environments:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/execution_environments/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define your Ansible Execution Environment:

{
  "lifecycle_environment": {
    "description": "My_Description",
    "name": "My_Ansible_Lifecycle_Environment_Name",
    "execution_environment_id": "My_Ansible_Execution_Environment_ID"
  }
}

Assign an Ansible Execution Environment to your Ansible lifecycle environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PUT \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

For your Ansible lifecycle environment, click the Ansible icon.

From the list of Ansible content, select versions of Ansible content that you want to use for this lifecycle environment.

Click Confirm to assign content to your lifecycle environment.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino shows your newly assigned Ansible content for your Ansible lifecycle environment.

Optional: Get a list of all Ansible lifecycle environments within your Ansible lifecycle environment path:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_Path_ID/ \
| jq

Create a JSON file, for example, data.json to define Ansible content for your Ansible lifecycle environment:

{
  "content_assignments": [
    {
      "id": "My_Ansible_Content_ID",
      "version": "My_Ansible_Content_Version"
    }
  ],
  "organization_id": "My_Organization_ID"
}

Assign Ansible content to your Ansible lifecycle environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_ID/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

In your Ansible lifecycle environment path, click the Arrow icon between two Ansible lifecycle environments.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino shows the Equal icon between your two Ansible lifecycle environments.

Optional: Get a list of all Ansible lifecycle environments with your Ansible lifecycle environment path:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define your left and right Ansible lifecycle environments:

{
  "promote": {
    "source_environment_id": "My_Left_Ansible_Environment_ID_",
    "target_environment_id": "My_Right_Ansible_Environment_ID_"
  }
}

Promote your Ansible lifecycle environment:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/My_Ansible_Lifecycle_Environment_Path_ID/promote/ \
| jq

In the orcharhino management UI, navigate to Ansible > Environments.

In your Ansible lifecycle environment path, click the Edit icon.

In your Ansible lifecycle environment, click the Delete icon.

Click Confirm to delete your Ansible lifecycle environment.

In the orcharhino management UI, navigate to Ansible > Environments.

For your Ansible lifecycle environment path, verify that orcharhino no longer shows your previously deleted Ansible lifecycle environment.

In the orcharhino management UI, navigate to Hosts > All Hosts.

In the list of hosts, select your host.

On the Overview tab, under Ansible lifecycle, click Library.

Click the Edit icon.

From the Lifecycle environment path menu, select your Ansible lifecycle environment path.

From the Lifecycle environment menu, select your Ansible lifecycle environment.

Click the Save icon to submit your changes.

In the orcharhino management UI, navigate to Hosts > All Hosts.

On the Overview tab, verify that orcharhino shows your newly assigned Ansible lifecycle environment path and Ansible lifecycle environment.

In the orcharhino management UI, navigate to Hosts > All Hosts.

Select your host.

On the Ansible Director tab, select the Content tab.

From the list of Ansible roles, select a version of an Ansible role and click on the Right Arrow icon.

Click the Save icon to assign Ansible roles to your host.

In the orcharhino management UI, navigate to Hosts > All Hosts.

Select your host.

On the Ansible Director tab, select the Content tab.

Verify that orcharhino shows your newly assigned Ansible roles.

Query the orcharhino API to get the ID of your host:

$ curl \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/hosts/ \
| jq ".results" | jq ".[]" | jq 'select(.name == "My_Host")' | jq ".id"

Query the orcharhino API to get the ID of your Ansible lifecycle environment:

$ curl \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/paths/ \
| jq ".results" | jq ".[]" | jq 'select(.name == "My_Ansible_Lifecycle_Environment_Path")' | jq ".lifecycle_environments" | jq ".[]" | jq 'select(.name == "My_Ansible_Lifecycle_Environment")' | jq ".id"

Query the orcharhino API to get the ID of your Ansible role:

$ curl \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_ID/ \
| jq ".content [] .roles" | jq ".[]" | jq 'select(.name == "My_Ansible_Role_Name")' | jq ".id"

Create a JSON file, for example, data.json to define your Ansible environment:

{
  "assignments": [
    {
      "assignable_name": "My_Ansible_Name",
      "assignable_namespace": "My_Ansible_Namespace",
      "assignable_role_name": "My_Ansible_Role_Name",
      "assignable_type": "ForemanAnsibleDirector::AnsibleCollectionRole"
    }
  ]
}

Assign Ansible roles to your host:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/assignments/host/My_Host_ID/ \
| jq

In the orcharhino management UI, navigate to Hosts > All Hosts.

In the list of hosts, select your host.

On the Ansible Director tab, click the Content tab.

From the list of assigned Ansible roles, select an Ansible role and click on the Left Arrow icon.

Click the Save icon to submit your changes.

In the orcharhino management UI, navigate to Ansible > Environments.

Verify that orcharhino shows your newly assign Ansible Execution Environment for your selected Ansible lifecycle environment.

Optional: Get a list of all assigned Ansible roles:

$ curl \
--header "Accept: application/json" \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/execution_environments/ \
| jq ".results | .[]"

Create a JSON file, for example, data.json to define your Ansible roles:

{
  "lifecycle_environment": {
    "description": "My_Description",
    "name": "My_Ansible_Lifecycle_Environment_Name",
    "execution_environment_id": "My_Ansible_Execution_Environment_ID"
  }
}

Unassign Ansible roles from your host:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PUT \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/ansible_director/lifecycle_environments/My_Ansible_Lifecycle_Environment_ID/ \
| jq

In the orcharhino management UI, navigate to Monitor > Jobs.

Click Run Job.

From the Job category menu, select Ansible Playbook.

From the Job template menu, select Apply Ansible configuration.

Click Next.

Select the hosts which you want to configure.

Follow the wizard to complete setting the remote job.

Click Submit to apply Ansible-based configuration to your selected hosts.

In the orcharhino management UI, navigate to Monitor > Jobs.

In the search bar, enter Configure the host using Ansible content assigned to it.

From the list of jobs, select the job that you previously started based on the search query and date.

Verify that orcharhino configured your selected hosts successfully.

Create a JSON file, for example, data.json to define your job invocation:

{
  "job_invocation": {
    "feature": "ansible_director_configure_host",
    "search_query": "name = host.example.com",
    "targeting_type": "static_query"
  }
}

Apply Ansible-based configuration to your host:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/job_invocations/ \
| jq ".id"

In the orcharhino management UI, navigate to Monitor > Jobs.

Click Run Job.

From the Job category menu, select Ansible Playbook.

From the Job template menu, select Apply Ansible configuration.

Click Next.

Select the hosts which you want to configure.

In the playbook field, enter your custom Ansible Playbook.

Follow the wizard to complete setting the remote job.

Click Submit to run an Ansible Playbook to your selected hosts.

In the orcharhino management UI, navigate to Monitor > Jobs.

In the search bar, enter Apply Ansible configuration.

From the list of jobs, select the job that you previously started based on the search query and date.

Verify that orcharhino configured your selected hosts successfully.

Create a JSON file, for example, data.json to define your job invocation:

{
  "job_invocation": {
    "feature": "ansible_run_playbook",
    "inputs": {
      "playbook": "n- name: \"My_Custom_Ansible_Playbook\"\n  hosts: all\n  tasks:\n    - name: \"My_Custom_Task\"\n      ansible.builtin.debug:\n        msg: \"My_Custom_Message\"\n...\n"
    },
    "search_query": "name = _host.example.com",
    "targeting_type": "static_query"
  }
}

Run your Ansible Playbook on your host:

$ curl \
--data @data.json \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST \
--user "My_User_Name:My_Password" \
https://orcharhino.example.com/api/v2/job_invocations/ \
| jq ".id"