1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Hosts

Update a Host

put

/api/v2/hosts/{id}/

Make a PUT or PATCH request to this resource to update this host. The following fields may be modified:

  • name: Name of this host. (string, required)
  • description: Optional description of this host. (string, default="")
  • inventory: (id, required)
  • enabled: Is this host online and available for running jobs? (boolean, default=True)
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string, default="")
  • variables: Host variables in JSON or YAML format. (json, default=``)

For a PUT request, include all fields in the request.

Request

Supported Media Types
Path Parameters
Query Parameters
Body ()
Root Schema : schema
Example:
{
    "description":"Hello world",
    "name":"New name"
}
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "ansible_facts_modified":null,
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"Hello world",
    "enabled":true,
    "has_active_failures":false,
    "has_inventory_sources":false,
    "id":1,
    "insights_system_id":null,
    "instance_id":"",
    "inventory":1,
    "last_job":null,
    "last_job_host_summary":null,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"New name",
    "related":{
        "activity_stream":"/api/v2/hosts/1/activity_stream/",
        "ad_hoc_command_events":"/api/v2/hosts/1/ad_hoc_command_events/",
        "ad_hoc_commands":"/api/v2/hosts/1/ad_hoc_commands/",
        "all_groups":"/api/v2/hosts/1/all_groups/",
        "ansible_facts":"/api/v2/hosts/1/ansible_facts/",
        "groups":"/api/v2/hosts/1/groups/",
        "insights":"/api/v2/hosts/1/insights/",
        "inventory":"/api/v2/inventories/1/",
        "inventory_sources":"/api/v2/hosts/1/inventory_sources/",
        "job_events":"/api/v2/hosts/1/job_events/",
        "job_host_summaries":"/api/v2/hosts/1/job_host_summaries/",
        "smart_inventories":"/api/v2/hosts/1/smart_inventories/",
        "variable_data":"/api/v2/hosts/1/variable_data/"
    },
    "summary_fields":{
        "groups":{
            "count":1,
            "results":[
                {
                    "id":1,
                    "name":"single-group"
                }
            ]
        },
        "inventory":{
            "description":"",
            "has_active_failures":false,
            "has_inventory_sources":false,
            "hosts_with_active_failures":0,
            "id":1,
            "inventory_sources_with_failures":0,
            "kind":"",
            "name":"test-inv",
            "organization_id":1,
            "total_groups":0,
            "total_hosts":0,
            "total_inventory_sources":0
        },
        "recent_jobs":[
        ],
        "user_capabilities":{
            "delete":true,
            "edit":true
        }
    },
    "type":"host",
    "url":"/api/v2/hosts/1/",
    "variables":""
}

403 Response

Body
Example Response (application/json)
{
    "detail":"You do not have permission to perform this action."
}
Back to Top